StopWatch.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2020-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// A stop watch for keeping time,
// based on https://github.com/vukis/Cpp-Utilities/tree/master/ThreadPool
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
#include <chrono>
#include <numeric>
 
template < typename TimeT = std::chrono::milliseconds, typename ClockT =
#if defined(_MSC_VER) && _MSC_VER == 1800
           std::chrono::system_clock
#else
           std::chrono::steady_clock
#endif
           >
class StopWatch {
public:
    StopWatch(const bool calibrate = false) : myTimingCost(0) {
        if (calibrate) {
            myStart = ClockT::now();
            for (int i = 0; i < 1000; i++) {
                myEnd = ClockT::now();
            }
            myTimingCost = std::chrono::duration_cast<TimeT>(myEnd - myStart) / 1000;
        }
        start();
    }
 
    void start() {
        myStart = myEnd = ClockT::now();
    }
 
    long long int stop() {
        myEnd = ClockT::now();
        return elapsed();
    }
 
    long long int elapsed() const {
        const TimeT& delta = std::chrono::duration_cast<TimeT>(myEnd - myStart) - (2 * myTimingCost);
        myHistory.push_back(delta);
        return (long long int)delta.count();
    }
 
    void add(const StopWatch<TimeT, ClockT>& other) {
        myHistory.insert(myHistory.end(), other.myHistory.begin(), other.myHistory.end());
    }
 
    const std::vector<TimeT>& getHistory() const {
        return myHistory;
    }
 
    long long int getAverage() const {
        return (long long int)(std::accumulate(myHistory.begin(), myHistory.end(), TimeT{}) / myHistory.size()).count();
    }
 
    long long int getTotal() const {
        return (long long int)(std::accumulate(myHistory.begin(), myHistory.end(), TimeT{})).count();
    }
 
private:
    std::chrono::time_point<ClockT> myStart;
    std::chrono::time_point<ClockT> myEnd;
    TimeT myTimingCost;
    mutable std::vector<TimeT>      myHistory;
};