root / man / man3 / HPL_ptimer.3 @ 1
Historique | Voir | Annoter | Télécharger (1,21 ko)
| 1 |
.TH HPL_ptimer 3 "September 10, 2008" "HPL 2.0" "HPL Library Functions" |
|---|---|
| 2 |
.SH NAME |
| 3 |
HPL_ptimer \- Timer facility. |
| 4 |
.SH SYNOPSIS |
| 5 |
\fB\&#include "hpl.h"\fR |
| 6 |
|
| 7 |
\fB\&void\fR |
| 8 |
\fB\&HPL_ptimer(\fR |
| 9 |
\fB\&const int\fR |
| 10 |
\fI\&I\fR |
| 11 |
\fB\&);\fR |
| 12 |
.SH DESCRIPTION |
| 13 |
\fB\&HPL_ptimer\fR |
| 14 |
provides a "stopwatch" functionality cpu/wall timer in |
| 15 |
seconds. Up to 64 separate timers can be functioning at once. The |
| 16 |
first call starts the timer, and the second stops it. This routine |
| 17 |
can be disenabled by calling HPL_ptimer_disable(), so that calls to |
| 18 |
the timer are ignored. This feature can be used to make sure certain |
| 19 |
sections of code do not affect timings, even if they call routines |
| 20 |
which have HPL_ptimer calls in them. HPL_ptimer_enable() will enable |
| 21 |
the timer functionality. One can retrieve the current value of a |
| 22 |
timer by calling |
| 23 |
|
| 24 |
t0 = HPL_ptimer_inquire( HPL_WALL_TIME | HPL_CPU_TIME, I ) |
| 25 |
|
| 26 |
where I is the timer index in [0..64). To inititialize the timer |
| 27 |
functionality, one must have called HPL_ptimer_boot() prior to any of |
| 28 |
the functions mentioned above. |
| 29 |
.SH ARGUMENTS |
| 30 |
.TP 8 |
| 31 |
I (global input) const int |
| 32 |
On entry, I specifies the timer to stop/start. |
| 33 |
.SH SEE ALSO |
| 34 |
.BR HPL_ptimer_cputime \ (3), |
| 35 |
.BR HPL_ptimer_walltime \ (3). |