对任何其他任意函数计时并返回其结果的函数

Question

我正在尝试编写一个函数，该函数接受任何其他任意函数作为输入并对其计时，然后返回该函数的结果。我已经研究了几个小时，并且认为我已经很接近了，但我仍然无法弄清楚如何编译它。

这是我目前所拥有的：

// Some arbitrary function to pass to the timer
int DoSomething(int x, double y)
{
    // Does something with x and y
    return 0;
}

// Function used to time another function and return its result
template <typename T, typename Function, typename... Args>
T GetRuntime(const std::string& name, const Function& function, Args&&... args)
{
    std::cout << name << " started..." << std::endl;
    auto start = std::chrono::high_resolution_clock::now();

    T result = function(std::forward<Args>(args)...);

    auto stop = std::chrono::high_resolution_clock::now();
    auto duration = std::chrono::duration_cast<std::chrono::milliseconds>(stop - start);
    std::cout << name << " complete - duration: " << duration.count() << " milliseconds." << std::endl;

    return result;
}

int main()
{
    // Doesn't compile
    int output = GetRuntime("DoSomething", DoSomething, 42, 42.42);
}

我是否以正确的方式处理这个问题？如果是这样，我需要改变什么才能使这项工作？如果不是，有什么更好的方法来解决这个问题？

Answer 1

这里的问题是 T 在你的函数中是不可推导的。您分配返回的值不参与模板参数扣除。要按原样使用它，您需要使用指定返回类型

int output = GetRuntime<int>("DoSomething", DoSomething, 42, 42.42);
                        ^^^ specify T is an int

但我们可以通过将auto 用作函数的返回类型来改善这一点。使用它将函数变为

template <typename Function, typename... Args>
auto GetRuntime(const std::string& name, const Function& function, Args&&... args)
{
    std::cout << name << " started..." << std::endl;
    auto start = std::chrono::high_resolution_clock::now();

    auto result = function(std::forward<Args>(args)...);

    auto stop = std::chrono::high_resolution_clock::now();
    auto duration = std::chrono::duration_cast<std::chrono::milliseconds>(stop - start);
    std::cout << name << " complete - duration: " << duration.count() << " milliseconds." << std::endl;

    return result;
}

Answer 2

编译器无法推断T。这是一个模板参数，但您的参数中没有任何内容可以推导出它。

但是，您可以使用std::invoke_result 来获取函数的返回类型：

template <typename Function, typename... Args, typename R = std::invoke_result_t<Function, Args...>>
auto GetRuntime(const std::string& name, const Function& function, Args&&... args) -> R {
    // ...
}

Answer 3

NathanOliver 已经给出了正确答案。这只是关于如何使函数更通用的答案。它也适用于void 函数，并且不进行任何日志记录。它返回一个元组，其中包含传递函数的持续时间和返回值。如果传递的函数返回void，则直接返回持续时间（无元组）。

（这都是 C++17。）

// Need these includes in addition to what you already include.
#include <tuple>
#include <type_traits>

template <typename Function, typename... Args>
auto GetRuntime(const Function& function, Args&&... args)
{
    auto start = std::chrono::high_resolution_clock::now();

    if constexpr (std::is_same_v<decltype(function(args...)), void>) {
        function(std::forward<Args>(args)...);
        return std::chrono::duration_cast<std::chrono::milliseconds>(
            std::chrono::high_resolution_clock::now() - start);
    } else {
        auto&& func_result{function(std::forward<Args>(args)...)};
        return std::make_tuple(
            std::chrono::duration_cast<std::chrono::milliseconds>(
                std::chrono::high_resolution_clock::now() - start),
                std::forward<decltype(function(args...))>(func_result));
    }
}

您可以直接使用它来获取持续时间：

auto duration = GetRunTime(void_func, arg1, arg2);
cout << "Took " << duration.count() << "ms.\n";

对于非空函数，您可以使用结构化绑定：

auto [duration, int_val] = GetRunTime(int_func, arg1, arg2);
cout << "Took " << duration.count() << "ms and returned " << int_val << '\n';

您的原始日志记录功能可以作为GetRuntime() 的包装器来实现。日志记录函数的返回类型将与传递函数的返回类型相同：

template <typename Function, typename... Args>
auto LogRuntime(const std::string& name, const Function& function, Args&&... args)
{
    std::cout << name << " starting..." << std::endl;
    auto result = GetRuntime(function, std::forward<Args>(args)...);
    std::cout << name << " complete - duration: ";
    constexpr auto is_void = std::is_same_v<decltype(function(args...)), void>;
    if constexpr (is_void) {
        std::cout << result.count();
    } else {
        std::cout << std::get<0>(result).count();
    }
    std::cout << " milliseconds.\n";
    if constexpr (!is_void) {
        return std::get<1>(result);
    }
}