GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MPI_WIN_TEST (3)

NAME

MPI_Win_test - Attempts to complete an RMA exposure epoch; a nonblocking version of MPI_Win_wait

CONTENTS

Syntax
C Syntax
Fortran Syntax
C++ Syntax
Input Parameters
Output Parameters
Description
Errors
See Also

SYNTAX

C Syntax

#include <mpi.h>
int MPI_Win_test(MPI_Win win, int *flag)

Fortran Syntax

INCLUDE ’mpif.h’
MPI_WIN_TEST( WIN, FLAG, IERROR)
        INTEGER  WIN, IERROR

C++ Syntax

#include <mpi.h>
bool MPI::Win::Test() const

INPUT PARAMETERS

win Window object (handle)

OUTPUT PARAMETERS

IERROR Fortran only: Error status (integer).
flag The returning state of the test for epoch closure.

DESCRIPTION

MPI_Win_test is a one-sided MPI communication synchronization call, a nonblocking version of MPI_Win_wait. It returns flag = true if MPI_Win_wait would return, flag = false otherwise. The effect of return of MPI_Win_test with flag = true is the same as the effect of a return of MPI_Win_wait. If flag = false is returned, then the call has no visible effect.

Invoke MPI_Win_test only where MPI_Win_wait can be invoked. Once the call has returned flag = true, it must not be invoked anew, until the window is posted anew.

ERRORS

Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI::Exception object.

Before the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Win_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error.

SEE ALSO

MPI_Win_post MPI_Win_wait

Search for    or go to Top of page |  Section 3 |  Main Index


1.10.2 MPI_WIN_TEST (3) Jan 21, 2016

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.