Rename functions warmup* -> warmUp*

Author: simphotonics

README.md

@@ -211,17 +211,18 @@ total benchmark run times within acceptable limits.
 <details> <summary> Click to show details. </summary>
 
 In a first step, benchmark scores are estimated using the
-functions [`warmup`][warmup]
-or [`warmupAsync`][warmupAsync]. The function [`BenchmarkHelper.sampleSize`][sampleSize]
-uses the score estimate to determine the sampling procedure.
+functions [`warmUp`][warmUp]
+or [`warmUpAsync`][warmUpAsync]. The function [`BenchmarkHelper.sampleSize`][sampleSize]
+uses the score estimate to determine the sample size and the number of inner
+iterations (for short run times each sample entry is averaged).
 
 ### 1. Default Sampling Method
 The graph below shows the sample size (orange curve) as calculated by the function
 [`BenchmarkHelper.sampleSize`][sampleSize].
 The green curve shows the lower limit of the total microbenchmark duration and
 represents the value: `clockTicks * sampleSize * innerIterations`.
 
-![Sample Size](https://raw.githubusercontent.com/simphotonics/benchmark_runner/main/images/sample_size.png)
+![Sample Size](https://raw.githubusercontent.com/simphotonics/benchmark_runner/custom-emitter/images/sample_size.png)
 
 For short run times below 100000 clock ticks each sample score is generated
 using the functions [`measure`][measure] or the equivalent asynchronous method [`measureAsync`][measureAsync].
@@ -238,7 +239,7 @@ averaged over (see the cyan curve in the graph above):
 To custominze the score sampling process, the static function
 [`BenchmarkHelper.sampleSize`][sampleSize] can be replaced with a custom function:
 ```Dart
-/// Generates a sample containing 100 benchmark scores. 
+/// Generates a sample containing 100 benchmark scores.
 BenchmarkHelper.sampleSize = (int clockTicks) {
   return (outer: 100, inner: 1)
 }
@@ -300,6 +301,6 @@ Please file feature requests and bugs at the [issue tracker][tracker].
 
 [sampleSize]: https://pub.dev/documentation/benchmark_runner/latest/benchmark_runner/BenchmarkHelper/sampleSize.html
 
-[warmup]: https://pub.dev/documentation/benchmark_runner/latest/benchmark_runner/BenchmarkHelper/warmup.html
+[warmUp]: https://pub.dev/documentation/benchmark_runner/latest/benchmark_runner/BenchmarkHelper/warmUp.html
 
-[warmupAsync]: https://pub.dev/documentation/benchmark_runner/latest/benchmark_runner/BenchmarkHelper/warmupAsync.html
+[warmUpAsync]: https://pub.dev/documentation/benchmark_runner/latest/benchmark_runner/BenchmarkHelper/warmUpAsync.html

lib/src/extension/benchmark_helper.dart

@@ -38,14 +38,14 @@ extension BenchmarkHelper on Stopwatch {
 
   /// Measures the runtime of [f] for [duration] and
   /// reports the average runtime expressed as clock ticks.
-  ({int ticks, int iter}) warmup(
+  ({int ticks, int iter}) warmUp(
     void Function() f, {
     Duration duration = const Duration(milliseconds: 200),
-    int preRuns = 3,
+    int warmUpRuns = 3,
   }) {
-    var ticks = microsecondsToTicks(duration.inMicroseconds);
-    var iter = 0;
-    for (var i = 0; i < preRuns; i++) {
+    int ticks = durationToTicks(duration);
+    int iter = 0;
+    for (var i = 0; i < warmUpRuns; i++) {
       f();
     }
     reset();
@@ -59,15 +59,15 @@ extension BenchmarkHelper on Stopwatch {
 
   /// Measures the runtime of [f] for [duration] and
   /// reports the average runtime expressed as clock ticks.
-  Future<({int ticks, int iter})> warmupAsync(
+  Future<({int ticks, int iter})> warmUpAsync(
     Future<void> Function() f, {
     Duration duration = const Duration(milliseconds: 200),
-    int preRuns = 3,
+    int warmUpRuns = 3,
   }) async {
-    var ticks = microsecondsToTicks(duration.inMicroseconds);
-    var iter = 0;
+    int ticks = durationToTicks(duration);
+    int iter = 0;
     reset();
-    for (var i = 0; i < preRuns; i++) {
+    for (var i = 0; i < warmUpRuns; i++) {
       await f();
     }
     start();
@@ -84,6 +84,10 @@ extension BenchmarkHelper on Stopwatch {
   /// Converts clock [ticks] to seconds.
   static double ticksToSeconds(int ticks) => ticks / BenchmarkHelper.frequency;
 
+  /// Convert [duration] to clock ticks.
+  static int durationToTicks(Duration duration) =>
+      microsecondsToTicks(duration.inMicroseconds);
+
   /// Converts clock [ticks] to microseconds.
   static double ticksToMicroseconds(int ticks) =>
       ticks / (BenchmarkHelper.frequency / 1000000);
@@ -124,8 +128,8 @@ extension BenchmarkHelper on Stopwatch {
   /// * number of runs each score is averaged over: `.inner`.
   ///
   /// Note: An estimate of the benchmark runtime in clock ticks is given by
-  /// `outer*inner*clockTicks`. The estimate does not include any setup, warmup,
-  /// or teardown functionality.
+  /// `outer*inner*clockTicks`. The estimate does not include any setup,
+  /// warm-up, or teardown functionality.
   static ({int outer, int inner}) sampleSizeDefault(int clockTicks) {
     // Estimates for the averaging used within `measure` and `measureAsync.