source: proiecte/hpl/openmpi_compiled/share/man/man3/MPI_Wtick.3 @ 97

Last change on this file since 97 was 97, checked in by (none), 14 years ago

Adding compiled files
File size: 1.1 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_Wtick 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_Wtick\fP \- Returns the resolution of MPI_Wtime.
6
7.SH SYNTAX
8.ft R
9.SH C Syntax
10.nf
11#include <mpi.h>
12double MPI_Wtick()
13
14.SH Fortran Syntax
15.nf
16INCLUDE 'mpif.h'
17DOUBLE PRECISION MPI_WTICK()
18
19.SH C++ Syntax
20.nf
21#include <mpi.h>
22double MPI::Wtick()
23
24.SH RETURN VALUE
25.ft R
26Time in seconds of resolution of MPI_Wtime.
27
28.SH DESCRIPTION
29.ft R
30MPI_Wtick returns the resolution of MPI_Wtime in seconds. That is, it
31returns, as a double-precision value, the number of seconds between
32successive clock ticks. For example, if the clock is implemented by
33the hardware as a counter that is incremented every millisecond, the
34value returned by MPI_Wtick should be 10^-3.
35.PP
36Note that on POSIX platforms, Open MPI should always return 10^-6 for
37MPI_Wtick.  The returned value may be different on Windows platforms.
38.PP
39
40.SH NOTE
41This function does not return an error value. Consequently, the result
42of calling it before MPI_Init or after MPI_Finalize is undefined.
43
44.SH SEE ALSO
45.ft R
46.sp
47MPI_Wtime
Note: See TracBrowser for help on using the repository browser.