Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/docs/benchmarks.md
diff options
context:
space:
mode:
authorMartin Hořeňovský2021-11-15 23:09:18 +0100
committerMartin Hořeňovský2021-11-15 23:09:18 +0100
commite86f84b8effb7ffcdc5c7d59b0acb577b4b26a9d (patch)
treed7c5057e2bce206762aebe3d62ad325fc6a10878 /docs/benchmarks.md
parentd012735c6e072e31a8ca39bd0901923754f65738 (diff)
downloadcatch3-e86f84b8effb7ffcdc5c7d59b0acb577b4b26a9d.tar.gz
Mention that run == iteration in benchmarking docs
Diffstat (limited to 'docs/benchmarks.md')
-rw-r--r--docs/benchmarks.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/benchmarks.md b/docs/benchmarks.md
index 101539dd..548913c7 100644
--- a/docs/benchmarks.md
+++ b/docs/benchmarks.md
@@ -11,7 +11,8 @@ First off, let's go over some terminology that will be used throughout this
guide.
- *User code*: user code is the code that the user provides to be measured.
-- *Run*: one run is one execution of the user code.
+- *Run*: one run is one execution of the user code. Sometimes also referred
+ to as an _iteration_.
- *Sample*: one sample is one data point obtained by measuring the time it takes
to perform a certain number of runs. One sample can consist of more than one
run if the clock available does not have enough resolution to accurately