1
1
openmpi/ompi/mpi/man/man3/MPI_Wtick.3in
Jeff Squyres dc53cd5f74 MPI_Wtick: may return a higher resolution than 10e-6 these days
Thanks to Mark Dixon (@ccaamad) for reporting the error.

Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
2017-03-02 10:39:28 -05:00

58 строки
1.2 KiB
Plaintext

.\" -*- nroff -*-
.\" Copyright 2006-2008 Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
.\" Copyright (c) 2017 Cisco Systems, Inc.
.\" $COPYRIGHT$
.TH MPI_Wtick 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.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 Fortran Syntax
.nf
USE MPI
! or the older form: INCLUDE 'mpif.h'
DOUBLE PRECISION MPI_WTICK()
.fi
.SH Fortran 2008 Syntax
.nf
USE mpi_f08
DOUBLE PRECISION MPI_WTICK()
.fi
.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