Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cicirello committed May 14, 2024
1 parent 4a4f132 commit d9e8a9d
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 5 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ Some of the randomization enhancements include:
* Methods for generating random samples of k integers without replacement from a range of integers.
* Methods to generate streams of numbers from distributions other than uniform, such as streams of random numbers
from binomial distributions, Cauchy distributions, exponential distributions, and Gaussian distributions.
* Methods to generate streams of pairs of distinct integers, and streams of triples of distinct integers.
* Methods for shuffling the elements of arrays and Lists.

The ρμ library is a dependency of some of our other projects,
including [JavaPermutationTools](https://github.com/cicirello/JavaPermutationTools)
Expand Down Expand Up @@ -179,7 +181,7 @@ and minimum supported Java version.

| version | Java requirements |
| --- | --- |
| 2.w.x to 3.y.z | Java 17+ |
| 2.w.x to 4.y.z | Java 17+ |
| 1.x.y | Java 11+ |

## Versioning Scheme
Expand Down Expand Up @@ -252,7 +254,7 @@ the version number with the version that you want to use.
<dependency>
<groupId>org.cicirello</groupId>
<artifactId>rho-mu</artifactId>
<version>3.0.0</version>
<version>4.0.0</version>
</dependency>
```

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/module-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@
* distributions, and Gaussian distributions.
* <li>Methods to generate streams of pairs of distinct integers, and streams of triples of
* distinct integers.
* <li>Methods for shuffling the elements of arrays.
* <li>Methods for shuffling the elements of arrays and Lists.
* </ul>
*
* <p>The <a href="https://github.com/cicirello/rho-mu" target=_top>source code repository</a> is
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
* distributions, and Gaussian distributions.
* <li>Methods to generate streams of pairs of distinct integers, and streams of triples of
* distinct integers.
* <li>Methods for shuffling the elements of arrays.
* <li>Methods for shuffling the elements of arrays and Lists.
* </ul>
*
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, <a
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/cicirello/math/rand/Shuffler.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
import java.util.random.RandomGenerator;

/**
* Shuffler is a class of utility methods for randomizing the order of elements in an array.
* Shuffler is a class of utility methods for randomizing the order of elements in arrays and Lists.
*
* @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, <a
* href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>
Expand Down

0 comments on commit d9e8a9d

Please sign in to comment.