Timer Class Reference

An object Timer gives information on the CPU time of long-time computations. More...

#include <Timer.h>

Public Member Functions
	Timer ()
	Constructor of Timer class. Initialize timer. More...
void	resetStart ()
	Resets time and start. More...
void	check ()
	Adds CPU time and real time to their buffers and resets. For long computations, it is recommended to do this operation at least once per iteration. More...
void	start ()
	Starts timer. More...
double	stop ()
	Stop timer and, if asked, returns CPU time from previous start in seconds. More...
double	CPUTime ()
	Returns CPU time from previous start in seconds. More...
double	realTime ()
	Returns real time from previous start in seconds. More...
void	add (double cpuTime, double realTime)
	Adds time to buffer (only when a computation is restarted). More...

Detailed Description

An object Timer gives information on the CPU time of long-time computations.

Constructor & Destructor Documentation

Timer::Timer

(

)

Constructor of Timer class. Initialize timer.

{
  StartCPUTime = clock();
  time(&StartRealTime);

  sumCPUtime = 0.;
  sumRealtime = 0.;
  TimerOn = true;
}

Member Function Documentation

void Timer::add	(	double	cpuTime,
		double	realTime
	)

Adds time to buffer (only when a computation is restarted).

Parameters

cpuTime	CPU time
realTime	Real time

Returns

void

{
        sumCPUtime=cpuTime;
        sumRealtime=realTime;
}

void Timer::check

(

)

Adds CPU time and real time to their buffers and resets. For long computations, it is recommended to do this operation at least once per iteration.

Returns

void

{
    // --- Local variables ---

  clock_t EndCPUTime;        // end CPU time

    // --- Execution ---

  EndCPUTime   =  clock();
  sumCPUtime   += double((unsigned long int)EndCPUTime-StartCPUTime)/ (unsigned long int)CLOCKS_PER_SEC;
  StartCPUTime =  EndCPUTime;

}

Here is the caller graph for this function:

double Timer::CPUTime

(

)

Returns CPU time from previous start in seconds.

Returns

double

{
    // --- Local variables ---
  clock_t EndCPUTime;

    // --- Execution ---
  if (TimerOn)
  {
        // If timer is running, compute and return time in seconds
    EndCPUTime = clock();
    return sumCPUtime+double((unsigned long int)EndCPUTime-StartCPUTime)/ (unsigned long int)CLOCKS_PER_SEC;
  }
  else
        // else return time previously computed between last start and stop procedures
    return sumCPUtime;
}

Here is the caller graph for this function:

double Timer::realTime

(

)

Returns real time from previous start in seconds.

Returns

double

{
    // --- Local variables ---

  time_t EndRealTime;

    // --- Execution ---

  if (TimerOn)
  {
        // If timer is running, compute and return time in seconds
    time(&EndRealTime);
    return sumRealtime+difftime(EndRealTime,StartRealTime);
  }
  else
        // else return time previously computed between last start and stop procedures
    return sumRealtime;
}

Here is the caller graph for this function:

void Timer::resetStart

(

)

Resets time and start.

Returns

void

{
  StartCPUTime = clock();
  time(&StartRealTime);

  sumCPUtime = 0.;
  sumRealtime = 0.;
  TimerOn = true;
}

void Timer::start

(

)

Starts timer.

Returns

void

{
  StartCPUTime = clock();
  time(&StartRealTime);

  TimerOn = true;
  return;
}

Here is the caller graph for this function:

double Timer::stop

(

)

Stop timer and, if asked, returns CPU time from previous start in seconds.

Returns

double

{
    // --- Local variables ---

  clock_t EndCPUTime;        // end CPU time
  time_t EndRealTime;        // end real time


    // --- Execution ---

  EndCPUTime = clock();
  time(&EndRealTime);

  sumCPUtime  += double((unsigned long int)EndCPUTime-StartCPUTime)/ (unsigned long int)CLOCKS_PER_SEC;
  sumRealtime += difftime(EndRealTime,StartRealTime);

  TimerOn = false;
  return sumCPUtime;
}

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• Timer.h
• Timer.cpp