Dune Core Modules (2.9.0)

Dune::Timer Class Reference

A simple stop watch. More...

#include <dune/common/timer.hh>

Public Member Functions

 Timer (bool startImmediately=true) noexcept
 A new timer, create and reset. More...
 
void reset () noexcept
 Reset timer while keeping the running/stopped state.
 
void start () noexcept
 Start the timer and continue measurement if it is not running. Otherwise do nothing.
 
double elapsed () const noexcept
 Get elapsed user-time from last reset until now/last stop in seconds.
 
double lastElapsed () const noexcept
 Get elapsed user-time from last start until now/last stop in seconds.
 
double stop () noexcept
 Stop the timer and return elapsed().
 

Detailed Description

A simple stop watch.

This class reports the elapsed user-time, i.e. time spent computing, after the last call to Timer::reset(). The results are seconds and fractional seconds. Note that the resolution of the timing depends on your OS kernel which should be somewhere in the millisecond range.

The class is basically a wrapper for the libc-function getrusage()

Warning
In a multi-threading situation, this class does NOT return wall-time! Instead, the run time for all threads will be added up. For example, if you have four threads running in parallel taking one second each, then the Timer class will return an elapsed time of four seconds.

Constructor & Destructor Documentation

◆ Timer()

Dune::Timer::Timer ( bool  startImmediately = true)
inlinenoexcept

A new timer, create and reset.

Parameters
startImmediatelyIf true (default) the timer starts counting immediately

References reset().


The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.80.0 (Apr 18, 22:30, 2024)