Skip to content

Latest commit

 

History

History
296 lines (197 loc) · 12.3 KB

CHANGELOG.md

File metadata and controls

296 lines (197 loc) · 12.3 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased] - 2024-08-16

Added

Changed

Deprecated

Removed

Fixed

Dependencies

CI/CD

Other

[4.2.0] - 2024-08-16

Changed

  • Refactored nextIntTriple to simplify logic, based on suggestion from anonymous reviewer of journal article submission. No impact on performance of array version of method, but code easier to read. Version that returns a record a few nanoseconds faster per call as well as easier to read.

[4.1.0] - 2024-06-08

Changed

  • Improved Gaussian random number generation from ThreadLocalRandom in methods of RandomVariates class (internal change).
  • Improved Gaussian random number generation in static methods of RandomVariates to choose between internal implementation of original ziggurat algorithm (for Java legacy random number generators Random and SecureRandom) or the Java API implementation of the modified ziggurat for all others (internal change).
  • Improved Gaussian random number generation in EnhancedRandomGenerator class to choose between internal implementation of original ziggurat algorithm (for Java legacy random number generator Random) or the Java API implementation of the modified ziggurat for all others (internal change).

Fixed

  • Added missing overrides in EnhancedSplittableRandom of the rngs and erngs methods.
  • Added missing overrides in EnhancedJumpableRandom of the rngs and erngs methods.

[4.0.0] - 2024-05-14

BREAKING CHANGES: See Removed and Changed sections for details.

Added

  • IndexPair record class for use in methods generating pairs of random indexes.
  • IndexTriple record class for use in methods generating triples of random indexes.
  • Methods in the RandomIndexer and EnhancedRandomGenerator classes that utilize the new IndexPair and IndexTriple when generating combinations of distinct random integers, as an alternative to the existing methods that return arrays, including:
    • Versions of nextIntPair using the new IndexPair class
    • Versions of nextIntTriple using the new IndexTriple class
    • Versions of nextWindowedIntPair using the new IndexPair class
    • Versions of nextWindowedIntTriple using the new IndexTriple class
  • Methods in the RandomIndexer and EnhancedRandomGenerator classes for generating additional combinations of distinct integers (both array-based versions and versions using IndexPair and IndexTriple), including:
    • nextSortedIntPair: a variation of nextIntPair whose result is in sorted order.
    • nextSortedIntTriple: a variation of nextIntTriple whose result is in sorted order.
    • nextSortedWindowedIntPair: a variation of nextWindowedIntPair whose result is in sorted order.
    • nextSortedWindowedIntTriple: a variation of nextWindowedIntTriple whose result is in sorted order.
  • Methods in the EnhancedRandomGenerator class for generating streams of combinations of distinct integers as streams of IndexPair or IndexTriple objects, including streams of the following:
    • Streams of random pairs of distinct integers (method pairs)
    • Streams of random pairs of distinct sorted integers (method sortedPairs)
    • Streams of random pairs of distinct integers, separated by at most a specified window (method windowedPairs)
    • Streams of random pairs of distinct sorted integers, separated by at most a specified window (method sortedWindowedPairs)
    • Streams of random triples of distinct integers (method triples)
    • Streams of random triples of distinct sorted integers (method sortedTriples)
    • Streams of random triples of distinct integers, separated by at most a specified window (method windowedTriples)
    • Streams of random triples of distinct sorted integers, separated by at most a specified window (method sortedWindowedTriples)
  • Shuffler class, and shuffle methods in EnhancedRandomGenerator class, for efficiently randomizing the ordering of elements in arrays and Lists.

Changed (BREAKING)

  • Changed ZigguratGaussian to a package-access class (BREAKING CHANGE): Instead use corresponding methods of the RandomVariates class.

Changed (non-breaking)

  • Refactored and optimized RandomIndexer.nextIntTriple methods.
  • Refactored and optimized RandomIndexer.nextWindowedIntPair methods.
  • Refactored and optimized RandomIndexer.nextWindowedIntTriple methods.

Removed

  • Removed PolarGaussian (BREAKING): Instead use corresponding methods of the RandomVariates class.

Fixed

  • Fixed potential finalizer vulnerability in class JacobiDiagonalization, identified by SpotBugs.

Dependencies

  • Bump org.cicirello:core from 2.5.0 to 2.7.0.
  • Retired publishing of a jar-with-dependencies (BREAKING CHANGE only if you were using the jar-with-dependencies).

[3.2.0] - 2024-03-29

Deprecated

  • Deprecated PolarGaussian, in preparation for future removal.
  • Deprecated ZigguratGaussian, in preparation for making it an internal package access class.

Fixed

  • Fixed exposed private array references in JacobiDiagonalization class.
  • Reformatted source code of example programs to Google Java Style for consistency with the library itself.

CI/CD

  • Integrated SpotBugs static analysis into build process.
  • Integrated Find Security Bugs static analysis into build process.
  • Removed support for importing from JitPack, iuncluding all JitPack configuration, workflows, workflow steps, and webhook.
  • Configured Spotify's fmt-maven-plugin to reformat the source code of the example programs to Google style during builds (the equivalent was already in place for the library's source code).

[3.1.1] - 2023-06-11

Changed

  • Refactored binomial random variate generation for improved algorithm constant caching

[3.1.0] - 2023-05-12

Added

  • MathFunctions.betai: incomplete beta function
  • Statistics.p: calculates p value from a t statistic and degrees of freedom

Dependencies

  • Bump core from 2.4.6 to 2.5.0

[3.0.4] - 2023-04-02

Changed

  • Minor optimization to RandomIndexer.nextIntPair

[3.0.3] - 2023-03-02

Dependencies

  • Bump core from 2.4.4 to 2.4.6

[3.0.2] - 2023-01-11

Dependencies

  • Bump core from 2.4.3 to 2.4.4

[3.0.1] - 2022-11-17

CI/CD

  • Begin publishing a jar-with-dependencies, in addition to the regular jar of the library, on deploys.

[3.0.0] - 2022-11-16

Changed

  • Refactored RandomIndexer and RandomSampler to use new dependency org.cicirello.core.
  • Reformatted all source code to Google Java style.

Removed

  • The sample, samplePool, sampleReservoir, and sampleInsertion methods of the RandomIndexer class, which were all deprecated in 2.5.0. Instead, use the methods with the same names in the RandomSampler class introduced in 2.5.0. BREAKING CHANGE

Dependencies

  • Added dependency org.cicirello.core 2.4.3.

Other

[2.5.0] - 2022-10-05

Added

  • RandomSampler: sampling without replacement from set of integers. This class has been extracted from the RandomIndexer class.

Changed

  • Refactored RandomIndexer class to decrease cyclomatic complexity, improve maintainability and reduce redundancy.
  • Refactored Statistics class, extracting an internal helper class InternalStatistics (motivated by Sonatype Lift's technical debt scan).
  • Refactored MatrixOps class (motivated by Sonatype Lift's technical debt scan).
  • Refactored test cases based on suggestion from Sonatype Lift's technical debt scan.

Deprecated

  • The sample, samplePool, sampleReservoir, and sampleInsertion methods of the RandomIndexer class. The equivalents of all of these are available in the new RandomSampler class.

[2.4.2] - 2022-09-02

Other

  • Release to push out documentation fix. No functional changes in this release to the library itself.

[2.4.1] - 2022-08-29

Other

  • No functional changes in this release: 2.4.1 is functionality equivalent to 2.4.0.
  • Release to push update to metadata out to Zenodo archive with citation details of JOSS article.
  • Documentation update to module page with citation details of JOSS article.

[2.4.0] - 2022-08-26

Added

  • Directory of example programs added to the GitHub repository, including:
    • Examples of the basic usage of the EnhancedRandomGenerator class, including potential use as a drop-in replacement, as well as demonstrations of enhancements to existing methods of Java's RandomGenerators, as well as functionality added by the class.
    • Demonstration of speed advantage of enhanced nextInt(bound) over Java API's builtin method.
    • Demonstration of ultrafast nextBiasedInt(bound) for cases where strict uniformity not needed.

[2.3.2] - 2022-07-15

Other

  • First release available via JitPack after configuring builds. No actual changes to library. In addition to Maven Central and GitHub Packages, the library can now be imported from JitPack as a fall-back option, as well as a source of snapshot artifacts built from the current default branch or specific commit hashes.

[2.3.1] - 2022-06-21

Documentation

  • Updated documentation on the module page.

[2.3.0] - 2022-05-09

Added

  • Streams of integers from binomial distributions.
  • Streams of doubles from Cauchy distributions.
  • Streams of doubles from exponential distributions.
  • Streams of doubles from Gaussian distributions.
  • Streams of not strictly uniform random integers.
  • Seeded constructors for the EnhancedSplittableGenerator, EnhancedStreamableGenerator, and EnhancedRandomGenerator classes.
  • Default constructors for the EnhancedStreamableGenerator and EnhancedSplittableGenerator classes.

[2.2.0] - 2022-04-30

Added

  • Subclasses of EnhancedRandomGenerator as wrappers for objects that implement the subinterfaces of RandomGenerator enabling adding to those objects all of the functionality of the RandomIndexer and RandomVariates classes. The new subclasses of EnhancedRandomGenerator include:
    • EnhancedSplittableGenerator, which is a wrapper for RandomGenerator.SplittableGenerator,
    • EnhancedJumpableGenerator, which is a wrapper for RandomGenerator.JumpableGenerator,
    • EnhancedLeapableGenerator, which is a wrapper for RandomGenerator.LeapableGenerator,
    • EnhancedStreamableGenerator, which is a wrapper for RandomGenerator.StreamableGenerator, and
    • EnhancedArbitrarilyJumpableGenerator, which is a wrapper for RandomGenerator.ArbitrarilyJumpableGenerator.

[2.1.0] - 2022-04-26

Added

  • EnhancedRandomGenerator class: wrapper for objects of classes that implement RandomGenerator, adding to those objects all of the functionality of the RandomIndexer and RandomVariates classes.

[2.0.0] - 2022-03-21

Breaking Changes Contains breaking changes, including increasing minimum supported Java version to Java 17.

Changed

  • Minimum supported Java version is now Java 17.
  • Refactored all classes in package org.cicirello.math.rand to use Java 17's new RandomGenerator interface.
  • Migrated test cases to JUnit Jupiter 5.8.2.

[1.2.0] - 2022-02-11

Added

  • Statistics.stdev(int[]) and Statistics.stdev(double[]) methods for sample standard deviation.

CI/CD

  • Added automated commenting of test coverage percentages to CI/CD workflow.

[1.1.0] - 2021-9-22

Added

  • Gaussian random number generators, specifically integrated the implementations from the Chips-n-Salsa library.

[1.0.0] - 2021-9-22

Added

  • This library provides the Java module org.cicirello.rho_mu, which includes the following packages in this initial release, all of which originated with the JavaPermutationTools library:
    • org.cicirello.math: Math functions needed by other functionality.
    • org.cicirello.math.la: Linear algebra related.
    • org.cicirello.math.rand: Efficient random sampling of single, pair, and triples of array indexes, as well as other randomization related functionality such as distributions other than random.
    • org.cicirello.math.stats: Statistics related functionality.