performanceTesting.hpp

Go to the documentation of this file.

// Copyright (c) 2020-2025 Cody R. Drisko. All rights reserved.
// Licensed under the MIT License. See the LICENSE file in the project root for more information.
//
// Name: performanceTesting.hpp
// Author: crdrisko
// Date: 10/20/2020-12:09:44
// Description: A function that can be used to time other functions
 
#ifndef DRYCHEM_COMMON_UTILITIES_INCLUDE_COMMON_UTILS_UTILITIES_TESTING_PERFORMANCETESTING_HPP
#define DRYCHEM_COMMON_UTILITIES_INCLUDE_COMMON_UTILS_UTILITIES_TESTING_PERFORMANCETESTING_HPP
 
#include <chrono>
#include <functional>
#include <type_traits>
#include <utility>
 
namespace CppUtils::Testing
{
    namespace details
    {
        template<typename F, typename... TArgs>
        struct ReturnType
        {
            std::invoke_result_t<F, TArgs...> result;
            std::chrono::microseconds::rep time;
        };
    }   // namespace details

    template<typename F, typename... TArgs>
    constexpr decltype(auto) timeAndInvoke(F&& f, TArgs&&... args)
    {
        if constexpr (std::is_void_v<std::invoke_result_t<F, TArgs...>>)
        {
            auto start = std::chrono::high_resolution_clock::now();
            std::invoke(std::forward<F>(f), std::forward<TArgs>(args)...);
            auto end = std::chrono::high_resolution_clock::now();
 
            auto duration = std::chrono::duration_cast<std::chrono::microseconds>(end - start).count();
 
            return duration;
        }
        else
        {
            auto start  = std::chrono::high_resolution_clock::now();
            auto result = std::invoke(std::forward<F>(f), std::forward<TArgs>(args)...);
            auto end    = std::chrono::high_resolution_clock::now();
 
            auto duration = std::chrono::duration_cast<std::chrono::microseconds>(end - start).count();
 
            return details::ReturnType<F, TArgs...> {result, duration};
        }
    }
}   // namespace CppUtils::Testing
 
#endif