[At-work.gif]

This is a draft; comments and suggestions are welcome.


PTR_GET_WALL_TIME(3)
PTR_GET_USR_TIME(3)
PTR_GET_SYS_TIME(3)

NAME
PTR_GET_WALL_TIME - Get current value of the wallclock timer.
PTR_GET_USR_TIME - Get current value of the User CPU timer.
PTR_GET_SYS_TIME - Get current value of the System CPU timer.

SYNOPSIS
#include <ptools_ptr_f.h>

Note: The types of the arguments passed to these routines may vary based on the platform. Please refer to the header file, "ptools_ptr_f.h", for information about this platform.

void PTR_GET_WALL_TIME (DOUBLE PRECISION wall_var);

void PTR_GET_USR_TIME (DOUBLE PRECISION usr_var);

void PTR_GET_SYS_TIME (DOUBLE PRECISION sys_var);

DESCRIPTION
NOTE: ??? refers to the prefix for any of the three timers: wallclock time (wall), user CPU time (usr), or system CPU time (sys).

These routines read the current wallclock, user CPU and system CPU timer values respectively. They are called before and after the code to be timed. These routines take one argument which is the user defined variable for storing the current timer value.

These routines are meant to be the least intrusive and are implemented using very low level routines or assembly code. No error detection is done because it is either too difficult or requires too much overhead.

The value returned by these routines are not necessarily meaningful in themselves as no conversions to time units are made. They may be register contents or some 64-bit quantitiy depending on the underlying system's representation of the current timer value. Interval calculating routines (see the SEE ALSO section below) are used to convert these values to seconds.

SEE ALSO
PTR_INIT_WALL_TIMER(3), PTR_INIT_USR_TIMER(3), PTR_INIT_SYS_TIMER(3), PTR_GET_WALL_INTERVAL(3), PTR_GET_USR_INTERVAL(3), PTR_GET_SYS_INTERVAL(3).

WARNINGS
The variable types (PTR_???_timer_val) are platform dependent and should be used for code portablity.


For further information, contact kennino@cs.orst.edu.