File checkpoint_timer.hpp¶

Implementation of the CheckpointTimer class.

License:: BSD 3-clause

Copyright: Copyright (c) 2020, New York University and Max Planck Gesellschaft

namespace real_time_tools¶

template<size_t NUM_CHECKPOINTS, bool ENABLED = true> class CheckpointTimer

#include <checkpoint_timer.hpp>

Timer to measure code execution time with “checkpoints”.

This timer is meant to be used for measuring execution time of a loop. It measures time between calls of the start method, so by calling this at the beginning of the loop, you get the execution time of the full iteration. Further, you can define “checkpoints” within the loop to measure time of separate steps in the loop. Call the checkpoint method after the code that is associated with it. For each checkpoint, the time elapsed since the last checkpoint is measured (start counts as a checkpoint in this regard).

Example:

    // set second template argument to false to disable timer
    real_time_tools::CheckpointTimer<3, true> timer;

    for (int i = 0; i < 1000; i++)
    {
        timer.start();

        init();
        timer.checkpoint("initialize");

        do_some_stuff();
        timer.checkpoint("do some stuff");

        write_log();
        timer.checkpoint("logging");

        // print the timing results every 100 iterations
        if (i % 100 == 0 && i > 0)
        {
            timer.print_statistics();
        }
    }

Template Parameters:

NUM_CHECKPOINTS – Number of checkpoints.
ENABLED – Set to false, to disable timer. Method calls will have no effect (and should hopefully be optimized away by the compiler).

Public Functions

CheckpointTimer()

void start(): Start timer iteration.

void checkpoint(const std::string &checkpoint_name)

Set checkpoint for time measurement.

Measures time from the last call of start() or checkpoint() until this call. The given name is used when printing the results.

Parameters:: checkpoint_name – Name of the checkpoint (used for printing results)

void print_statistics() const: Print results of time measurements.

Private Members

std::array<real_time_tools::Timer, NUM_CHECKPOINTS + 1> timers_

Timers used for the different checkpoints.

Index 0 is used for the total duration.

std::array<std::string, NUM_CHECKPOINTS + 1> checkpoint_names_: Names of the checkpoints.

size_t current_checkpoint_ = 1: Index of the current checkpoint.