TicToc.hh

Go to the documentation of this file.

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *\
 * Copyright (c) 2025, Davide Stocco and Enrico Bertolazzi.                                      *
 *                                                                                               *
 * The Sandals project is distributed under the BSD 2-Clause License.                            *
 *                                                                                               *
 * Davide Stocco                                                               Enrico Bertolazzi *
 * University of Trento                                                     University of Trento *
 * e-mail: davide.stocco@unitn.it                             e-mail: enrico.bertolazzi@unitn.it *
\* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
#pragma once
 
#ifndef SANDALS_TIC_TOC_HH
#define SANDALS_TIC_TOC_HH
 
#include <Sandals.hh>
 
namespace Sandals {
 
  /*\
   |   _____ _     _____
   |  |_   _(_) __|_   _|__   ___
   |    | | | |/ __|| |/ _ \ / __|
   |    | | | | (__ | | (_) | (__
   |    |_| |_|\___||_|\___/ \___|
   |
  \*/

  template <typename Real>
  class TicToc {
 
    using Clock = std::chrono::high_resolution_clock; 
    using Time  = std::chrono::microseconds;          
 
    Clock::time_point m_start_time;   
    Clock::time_point m_stop_time;    
    Time              m_elapsed_time; 
 
  public:
    TicToc(const TicToc &) = delete;

    TicToc & operator=(TicToc const &) = delete;

    TicToc() : m_elapsed_time(0) {}

    void tic() {this->m_start_time = Clock::now();}

    void toc()
    {
      this->m_stop_time    = Clock::now();
      this->m_elapsed_time = std::chrono::duration_cast<Time>(
        this->m_stop_time - this->m_start_time
      );
    }

    Real elapsed_s() const {return Real(1.0e-6)*this->m_elapsed_time.count();}

    Real elapsed_ms() const {return Real(1.0e-3)*this->m_elapsed_time.count();}

    Real elapsed_us() const {return this->m_elapsed_time.count();}
 
  }; // class TicToc
 
} // namespace Sandals
 
#endif // SANDALS_TIC_TOC_HH