File Coverage

/usr/local/lib/perl5/site_perl/5.26.1/x86_64-linux/XS/libcatch.x/i/catch2/benchmark/detail/catch_estimate_clock.hpp

Criterion	Covered	Total	%
statement	0	47	0.0
branch	0	54	0.0
condition			n/a
subroutine			n/a
pod			n/a
total	0	101	0.0

//              Copyright Catch2 Authors
// Distributed under the Boost Software License, Version 1.0.
//   (See accompanying file LICENSE_1_0.txt or copy at
//        https://www.boost.org/LICENSE_1_0.txt)

// SPDX-License-Identifier: BSL-1.0
// Adapted from donated nonius code.

#ifndef CATCH_ESTIMATE_CLOCK_HPP_INCLUDED
#define CATCH_ESTIMATE_CLOCK_HPP_INCLUDED

#include
#include
#include
#include
#include
#include
#include

#include
#include
#include
#include

namespace Catch {
    namespace Benchmark {
        namespace Detail {
            template
            std::vector resolution(int k) {
                std::vector> times;
                times.reserve(k + 1);
                std::generate_n(std::back_inserter(times), k + 1, now{});

                std::vector deltas;
                deltas.reserve(k);
                std::transform(std::next(times.begin()), times.end(), times.begin(),
                    std::back_inserter(deltas),
                    [](TimePoint a, TimePoint b) { return static_cast((a - b).count()); });

                return deltas;
            }

            const auto warmup_iterations = 10000;
            const auto warmup_time = std::chrono::milliseconds(100);
            const auto minimum_ticks = 1000;
            const auto warmup_seed = 10000;
            const auto clock_resolution_estimation_time = std::chrono::milliseconds(500);
            const auto clock_cost_estimation_time_limit = std::chrono::seconds(1);
            const auto clock_cost_estimation_tick_limit = 100000;
            const auto clock_cost_estimation_time = std::chrono::milliseconds(10);
            const auto clock_cost_estimation_iterations = 10000;

            template
            int warmup() {
                return run_for_at_least(std::chrono::duration_cast>(warmup_time), warmup_seed, &resolution)
                    .iterations;
            }
            template
            EnvironmentEstimate> estimate_clock_resolution(int iterations) {
                auto r = run_for_at_least(std::chrono::duration_cast>(clock_resolution_estimation_time), iterations, &resolution)
                    .result;
                return {
                    FloatDuration(mean(r.begin(), r.end())),
                    classify_outliers(r.begin(), r.end()),
                };
            }
            template
            EnvironmentEstimate> estimate_clock_cost(FloatDuration resolution) {
                auto time_limit = (std::min)(
                    resolution * clock_cost_estimation_tick_limit,
                    FloatDuration(clock_cost_estimation_time_limit));
                auto time_clock = [](int k) {
                    return Detail::measure([k] {
                        for (int i = 0; i < k; ++i) {
                            volatile auto ignored = Clock::now();
                            (void)ignored;
                        }
                    }).elapsed;
                };
                time_clock(1);
                int iters = clock_cost_estimation_iterations;
                auto&& r = run_for_at_least(std::chrono::duration_cast>(clock_cost_estimation_time), iters, time_clock);
                std::vector times;
                int nsamples = static_cast(std::ceil(time_limit / r.elapsed));
                times.reserve(nsamples);
                std::generate_n(std::back_inserter(times), nsamples, [time_clock, &r] {
                    return static_cast((time_clock(r.iterations) / r.iterations).count());
                });
                return {
                    FloatDuration(mean(times.begin(), times.end())),
                    classify_outliers(times.begin(), times.end()),
                };
            }

            template
            Environment> measure_environment() {
#if defined(__clang__)
#    pragma clang diagnostic push
#    pragma clang diagnostic ignored "-Wexit-time-destructors"
#endif
                static Catch::Detail::unique_ptr>> env;
#if defined(__clang__)
#    pragma clang diagnostic pop
#endif
                if (env) {
                    return *env;
                }

                auto iters = Detail::warmup();
                auto resolution = Detail::estimate_clock_resolution(iters);
                auto cost = Detail::estimate_clock_cost(resolution.mean);

                env = Catch::Detail::make_unique>>( Environment>{resolution, cost} );
                return *env;
            }
        } // namespace Detail
    } // namespace Benchmark
} // namespace Catch

#endif // CATCH_ESTIMATE_CLOCK_HPP_INCLUDED