aboutsummaryrefslogtreecommitdiff
path: root/tests/bench
diff options
context:
space:
mode:
authorPaul Duncan <pabs@pablotron.org>2024-04-29 13:00:27 -0400
committerPaul Duncan <pabs@pablotron.org>2024-04-29 13:00:27 -0400
commit6dc9ea81cb7a2ae5117f0a9cb4af7ccf7aaf97d0 (patch)
treea504d382ef27d41c06947a68529cb6ab86f50c83 /tests/bench
parentf4ac5be2d5c2c3153d8b744b10bfef7651497dcf (diff)
downloadsha3-6dc9ea81cb7a2ae5117f0a9cb4af7ccf7aaf97d0.tar.bz2
sha3-6dc9ea81cb7a2ae5117f0a9cb4af7ccf7aaf97d0.zip
tests/bench/README.md: remove mean_cpb, add "cycles per byte" link, misc cleanups
Diffstat (limited to 'tests/bench')
-rw-r--r--tests/bench/README.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/tests/bench/README.md b/tests/bench/README.md
index 1758c04..0d792e9 100644
--- a/tests/bench/README.md
+++ b/tests/bench/README.md
@@ -8,10 +8,9 @@ Requires [libcpucycles][].
The columns of the [CSV][] printed to standard output are as follows:
* `function`: Function name.
-* `dst`: Output size, in bytes.
-* `src`: Input size, in bytes.
-* `median_cpb`: [Median][] of observed CPU cycles divided by the input size.
-* `mean_cpb`: [Arithmetic mean][mean] of observed CPU cycles divided by the input size.
+* `dst`: Output length, in bytes.
+* `src`: Input length, in bytes.
+* `median_cpb`: [Median][] [cycles per byte][] (e.g. `median_cycles/src`).
* `median_cycles`: [Median][] of observed CPU cycles.
* `mean_cycles`: [Arithmetic mean][mean] of observed CPU cycles.
* `stddev_cycles`: [Standard deviation][stddev] of observed CPU cycles.
@@ -109,3 +108,5 @@ TODO...
"64-bit extension to the ARM instruction set."
[avx-512]: https://en.wikipedia.org/wiki/AVX-512
"AVX-512: 512-bit extensions to the Advanced Vector Extensions (AVX) instruction set."
+[cycles per byte]: https://en.wikipedia.org/wiki/Encryption_software#Performance
+ "Observed CPU cycles divided by the number of input bytes."