projects
/
yaz-moved-to-github.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (from parent 1:
ee20007
)
Comment timing util
author
Adam Dickmeiss
<adam@indexdata.dk>
Thu, 14 Jan 2010 15:16:05 +0000
(16:16 +0100)
committer
Adam Dickmeiss
<adam@indexdata.dk>
Thu, 14 Jan 2010 15:16:05 +0000
(16:16 +0100)
include/yaz/timing.h
patch
|
blob
|
history
diff --git
a/include/yaz/timing.h
b/include/yaz/timing.h
index
6f4b53a
..
60456c0
100644
(file)
--- a/
include/yaz/timing.h
+++ b/
include/yaz/timing.h
@@
-27,7
+27,8
@@
/**
* \file timing.h
/**
* \file timing.h
- * \brief Timing Utilities
+ \brief Timing Utilities
+
*/
#ifndef YAZ_TIMING_H
*/
#ifndef YAZ_TIMING_H
@@
-37,20
+38,69
@@
YAZ_BEGIN_CDECL
YAZ_BEGIN_CDECL
+/** \brief YAZ timing handle (opaque type)
+ */
typedef struct yaz_timing *yaz_timing_t;
typedef struct yaz_timing *yaz_timing_t;
+/** \brief create timing handle
+ \returns timing handle
+
+ \verbatim
+ yaz_timing_t my = yaz_timing_create();
+ yaz_timing_start(my);
+ do_work();
+ yaz_timing_stop(my);
+
+ printf("real=%g user=%g sys=%g\n",
+ yaz_timing_get_real(my),
+ yaz_timing_get_user(my),
+ yaz_timing_get_sys(my));
+
+ yaz_timing_destroy(my);
+
+ \endverbatim
+ */
YAZ_EXPORT
yaz_timing_t yaz_timing_create(void);
YAZ_EXPORT
yaz_timing_t yaz_timing_create(void);
+
+/** \brief start timer
+ \param t timing handle
+ */
YAZ_EXPORT
void yaz_timing_start(yaz_timing_t t);
YAZ_EXPORT
void yaz_timing_start(yaz_timing_t t);
+
+/** \brief stop timer
+ \param t timing handle
+
+ Use yaz_timing_get_real, yaz_timing_get_user and yaz_timing_get_sys
+ to fetch timing results.
+*/
YAZ_EXPORT
void yaz_timing_stop(yaz_timing_t t);
YAZ_EXPORT
void yaz_timing_stop(yaz_timing_t t);
+
+/** \brief returns real time in seconds
+ \param t timing handle
+ \returns time in seconds
+*/
YAZ_EXPORT
double yaz_timing_get_real(yaz_timing_t t);
YAZ_EXPORT
double yaz_timing_get_real(yaz_timing_t t);
+
+/** \brief returns user time in seconds
+ \param t timing handle
+ \returns time in seconds
+*/
YAZ_EXPORT
double yaz_timing_get_user(yaz_timing_t t);
YAZ_EXPORT
double yaz_timing_get_user(yaz_timing_t t);
+
+/** \brief returns system time in seconds
+ \param t timing handle
+ \returns time in seconds
+*/
YAZ_EXPORT
double yaz_timing_get_sys(yaz_timing_t t);
YAZ_EXPORT
double yaz_timing_get_sys(yaz_timing_t t);
+
+/** \brief destroys timing handle
+*/
YAZ_EXPORT
void yaz_timing_destroy(yaz_timing_t *tp);
YAZ_EXPORT
void yaz_timing_destroy(yaz_timing_t *tp);