39 lines
963 B
Groff
39 lines
963 B
Groff
.\" -*- nroff -*-
|
|
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
|
.\" Copyright (c) 1996 Thinking Machines Corporation
|
|
.\" Copyright (c) 2017 Cisco Systems, Inc.
|
|
.\" $COPYRIGHT$
|
|
.TH MPI_Wtick 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
|
.SH NAME
|
|
\fBMPI_Wtick\fP \- Returns the resolution of MPI_Wtime.
|
|
|
|
.SH SYNTAX
|
|
.ft R
|
|
.SH C Syntax
|
|
.nf
|
|
#include <mpi.h>
|
|
double MPI_Wtick()
|
|
|
|
.fi
|
|
.SH RETURN VALUE
|
|
.ft R
|
|
Time in seconds of resolution of MPI_Wtime.
|
|
|
|
.SH DESCRIPTION
|
|
.ft R
|
|
MPI_Wtick returns the resolution of MPI_Wtime in seconds. That is, it
|
|
returns, as a double-precision value, the number of seconds between
|
|
successive clock ticks. For example, if the clock is implemented by
|
|
the hardware as a counter that is incremented every millisecond, the
|
|
value returned by MPI_Wtick should be 10^-3.
|
|
.PP
|
|
|
|
.SH NOTE
|
|
This function does not return an error value. Consequently, the result
|
|
of calling it before MPI_Init or after MPI_Finalize is undefined.
|
|
|
|
.SH SEE ALSO
|
|
.ft R
|
|
.sp
|
|
MPI_Wtime
|