ρμ

Overview

ρμ is a Java library of Randomization enHancements and Other Math Utilities (rho mu). It includes implementations of various algorithms for efficiently randomly sampling combinations of indexes into arrays and other sequential structures. It also includes efficient implementations of random number generation from distributions other than uniform, such as Gaussian, Cauchy, etc. Additionally, it includes implementations of other math functions that are either needed by the randomization utilities, or which are needed by some of our other projects.

All of the initial functionality of ρμ originated in some of our other libraries, including JavaPermutationTools and Chips-n-Salsa. However, we found ourselves beginning to add one or the other of those libraries as dependencies in some other projects strictly for the randomization utilities, which is certainly less than ideal. Therefore, we have extracted ρμ from those libraries.

The ρμ source code repository is hosted on GitHub; and is licensed under the GNU General Public License Version 3 (GPLv3). The API documentation is found on this site. The library is regularly published to Maven Central, from which it is easily imported into software projects using Maven and other commonly used build tools.

The ρμ library originated as part of the research of Vincent A. Cicirello.

Importing from Maven Central

To import ρμ from the Maven Central repository (if your build tool is Maven), add the following to the dependencies section of your “pom.xml” (for other build tools, see your build tool's documentation for the equivalent):

<dependency>
  <groupId>org.cicirello</groupId>
  <artifactId>rho-mu</artifactId>
  <version>1.0.0</version>
</dependency>

Just replace the version number with your desired version of the library.

Java Modules

ρμ provides a Java module, org.cicirello.rho_mu. To use in your project, add the following to your module-info.java:


module your.module.name.here {
	requires org.cicirello.rho_mu;
}

Semantic Versioning

ρμ uses Semantic Versioning with version numbers of the form: MAJOR.MINOR.PATCH, where differences in MAJOR correspond to incompatible API changes, differences in MINOR correspond to introduction of backwards compatible new functionality, and PATCH corresponds to backwards compatible bug fixes.

Development Process

To maintain a high quality library, our development process utilizes the following: