Skip to content

Commit

Permalink
regenerate documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
martinus committed Apr 1, 2023
1 parent 5d579e6 commit 9f871ad
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ <h2><a class="reference internal" href="#_CPPv4N6ankerl9nanobench5BenchE" title=
<dt class="sig sig-object cpp" id="_CPPv4N6ankerl9nanobench5Bench12minEpochTimeENSt6chrono11nanosecondsE">
<span id="_CPPv3N6ankerl9nanobench5Bench12minEpochTimeENSt6chrono11nanosecondsE"></span><span id="_CPPv2N6ankerl9nanobench5Bench12minEpochTimeENSt6chrono11nanosecondsE"></span><span id="ankerl::nanobench::Bench::minEpochTime__std::chrono::nanoseconds"></span><span class="target" id="classankerl_1_1nanobench_1_1Bench_1a15fc41385e77877d7568797fbadba5f9"></span><a class="reference internal" href="#_CPPv4N6ankerl9nanobench5BenchE" title="ankerl::nanobench::Bench"><span class="n"><span class="pre">Bench</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="sig-name descname"><span class="n"><span class="pre">minEpochTime</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">chrono</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">nanoseconds</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">t</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><a class="headerlink" href="#_CPPv4N6ankerl9nanobench5Bench12minEpochTimeENSt6chrono11nanosecondsE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Minimum time each epoch should take. </p>
<p>Default is zero, so we are fully relying on <a class="reference internal" href="#classankerl_1_1nanobench_1_1Bench_1a13097e497dac40f467b42b2f54b8bb43"><span class="std std-ref">clockResolutionMultiple()</span></a>. In most cases this is exactly what you want. If you see that the evaluation is unreliable with a high <code class="docutils literal notranslate"><span class="pre">err%</span></code>, you can increase either <a class="reference internal" href="#classankerl_1_1nanobench_1_1Bench_1a15fc41385e77877d7568797fbadba5f9"><span class="std std-ref">minEpochTime()</span></a> or <a class="reference internal" href="#classankerl_1_1nanobench_1_1Bench_1a58417b962f49acec5e323e8e736109a6"><span class="std std-ref">minEpochIterations()</span></a>.</p>
<p>Default is 1ms, so we are mostly relying on <a class="reference internal" href="#classankerl_1_1nanobench_1_1Bench_1a13097e497dac40f467b42b2f54b8bb43"><span class="std std-ref">clockResolutionMultiple()</span></a>. In most cases this is exactly what you want. If you see that the evaluation is unreliable with a high <code class="docutils literal notranslate"><span class="pre">err%</span></code>, you can increase either <a class="reference internal" href="#classankerl_1_1nanobench_1_1Bench_1a15fc41385e77877d7568797fbadba5f9"><span class="std std-ref">minEpochTime()</span></a> or <a class="reference internal" href="#classankerl_1_1nanobench_1_1Bench_1a58417b962f49acec5e323e8e736109a6"><span class="std std-ref">minEpochIterations()</span></a>.</p>
<p><div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#classankerl_1_1nanobench_1_1Bench_1aef7bbd7a1f059dda0e03ed47748b8f13"><span class="std std-ref">maxEpochTime</span></a>, <a class="reference internal" href="#classankerl_1_1nanobench_1_1Bench_1a58417b962f49acec5e323e8e736109a6"><span class="std std-ref">minEpochIterations</span></a></p>
Expand Down
Loading

0 comments on commit 9f871ad

Please sign in to comment.