Skip to content

Commit

Permalink
Update README section on running testu01 and benchmarks.
Browse files Browse the repository at this point in the history
  • Loading branch information
Pass Automated Testing Suite authored and Pass Automated Testing Suite committed May 5, 2024
1 parent bf74258 commit 669f6b4
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,10 @@ Supported bitgenerators include: `PCG64`, `Philox4x64`, `Xoshiro256`, `ChaCha` a

## Empirical Randomness Testing
Running the test suite provided by [TestU01][6] on the supported generators is supported.
To build the test executable one needs to run `dune build bin`. To see the available
command options run `dune exec -- crush -help`. Below is a sample output from running
`dune exec -- crush pcg64` to test `PCG64` on the Small Crush test suite:
To see the available commandline options run `dune exec -- ./bin/crush.exe -help`.
Below is a sample output from running `dune exec -- ./bin/crush.exe -name smallcrush pcg64`
to test `PCG64` on the Small Crush test suite:
```shell
$ dune exec -- crush pcg64

========= Summary results of SmallCrush =========

Version: TestU01 1.2.3
Expand All @@ -101,8 +99,8 @@ $ dune exec -- crush pcg64
```
## Benchmarks
A utility to compare the performance of each bitgenerator's `next_uint64` function is provided.
To compile the benchmark executor run `dune build bin`, and then run it using `dune exec -- bench`.
Once the benchmark run has completed, a summary table will be displayed in stdout.
Run the microbenchmark using `dune exec -- ./bin/bench.exe` and once it has completed,
a summary table will be displayed in stdout.


[1]: https://codecov.io/gh/zoj613/bitgenerators/graph/badge.svg?token=KOOG2Y1SH5
Expand Down

0 comments on commit 669f6b4

Please sign in to comment.