stopwatch.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-2015:  G-CSC, Goethe University Frankfurt
 * Author: Martin Rupp, Torbjoern Klatt
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 */
 
#ifndef __H__UG__STOPWATCH_H__
#define __H__UG__STOPWATCH_H__
 
// The following define is a leftover from pre-C++11 times.
// Def or undef to switch between the two implementations.
#define UG_CXX11
 
#include <iostream>
 
#ifdef UG_CXX11
#include <chrono>
#else
#include <ctime>
#endif
 
#ifdef UG_POSIX
  #include <sys/time.h>
#endif
 
namespace ug
{
 
 
 
class CuckooClock{
 
 public:
 CuckooClock() : m_tlaunch(0), m_tdone(0), m_ttotal(0) {}
 
  void tic(){m_tlaunch = clock();}
 
  double toc()
  {
    m_tdone = clock();
    //std::cerr << m_tdone;
    clock_t delta= (m_tdone-m_tlaunch);
    m_ttotal += delta;
    return 1.0*delta/CLOCKS_PER_SEC;
  }
 
  double cuckoo() {return 1.0*m_ttotal/ CLOCKS_PER_SEC;}
 
protected:
 
    clock_t m_tlaunch;
    clock_t m_tdone;
    clock_t m_ttotal;
};
 
 
#ifdef UG_POSIX
  inline double get_clock_s()
  {
    timeval time;
    gettimeofday(&time, NULL);
    return time.tv_sec + time.tv_usec/1000000.0;
  }
#else
  inline double get_clock_s()
  {
    return clock() / ((double)CLOCKS_PER_SEC);
  }
#endif
 
 
class Stopwatch
{
  public:
    Stopwatch() {
      // you cant be really sure when constructor is called
#ifdef UG_CXX11
      begin = std::chrono::high_resolution_clock::now();
      end = std::chrono::high_resolution_clock::now();
#else
      beg = end = get_clock_s();
#endif
      bRunning = false;
    }
    
    void start() {
      std::cout.flush();
#ifdef UG_CXX11
      begin = std::chrono::high_resolution_clock::now();
#else
      beg = get_clock_s();
#endif
      bRunning = true;
    }
 
    void stop() {
#ifdef UG_CXX11
      end = std::chrono::high_resolution_clock::now();
#else
      end = get_clock_s();
#endif
      bRunning = false;
    }
 
    friend std::ostream &operator << ( std::ostream &out, Stopwatch &s ) {
      out << s.ms() << " ms";
      return out;
    }
 
    double ms() {
#ifdef UG_CXX11
      if ( bRunning ) end = std::chrono::high_resolution_clock::now();
      return std::chrono::duration_cast<std::chrono::milliseconds> (end-begin).count();
#else
      if( bRunning ) end = get_clock_s();
      return ( end - beg ) * 1000.0;
#endif
    }
 
  private:
#ifdef UG_CXX11
    std::chrono::high_resolution_clock::time_point begin;
 
    std::chrono::high_resolution_clock::time_point end;
#else
    double beg;
    double end;
#endif
    bool bRunning;
};
 
// end group ugbase_common
 
} // namespace ug
 
 
#endif // __H__UG__STOPWATCH_H__