gensvm_timer.h File Reference

Header file for gensvm_timer.c. More...

#include "gensvm_globals.h"

Include dependency graph for gensvm_timer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	Timer(spec)   clock_gettime(CLOCK_MONOTONIC_RAW, &spec)
	Timer macro for easily recording time. More...

Functions
double	gensvm_elapsed_time (struct timespec *start, struct timespec *stop)
	Calculate the time between two time recordings. More...

Detailed Description

Header file for gensvm_timer.c.

Author

G.J.J. van den Burg

Date

2013-08-01

Function declaration for timer function used to measure computation time.

Copyright

Copyright 2016, G.J.J. van den Burg.

This file is part of GenSVM.

GenSVM is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

GenSVM 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with GenSVM. If not, see http://www.gnu.org/licenses/.

Definition in file gensvm_timer.h.

Macro Definition Documentation

Timer

#define Timer

(

spec

)

clock_gettime(CLOCK_MONOTONIC_RAW, &spec)

Timer macro for easily recording time.

Definition at line 37 of file gensvm_timer.h.

Function Documentation

gensvm_elapsed_time()

double gensvm_elapsed_time	(	struct timespec *	start,
		struct timespec *	stop
	)

Calculate the time between two time recordings.

This function should be used with time recordings done by clock_gettime() using CLOCK_MONOTONIC_RAW. For this, the Timer() macro has been defined in the header file. Example usage:

struct timespec start, stop;
Timer(start);
// do some work //
Timer(stop);
double duration = gensvm_elapsed_time(&start, &stop);

This approach to measuring time has been chosen since CLOCK_MONOTONIC_RAW is guaranteed to be monotonically increasing, and is not affected by leap seconds or other changes to the system clock. It is therefore thread-safe and can be used to accurately measure time intervals.

Parameters

[in]	start	starting time
[in]	stop	end time

Returns

time elapsed in seconds

Definition at line 58 of file gensvm_timer.c.