MPI Subroutine Reference

MPE_ISCAN, MPE_Iscan

Purpose

Performs a nonblocking scan operation.

C synopsis

#include <mpi.h>
int MPE_Iscan(void* sendbuf,void* recvbuf,int count,
    MPI_Datatype datatype,MPI_Op op,MPI_Comm comm,
    MPI_Request *request);

FORTRAN synopsis

include 'mpif.h' or use mpi
MPE_ISCAN(CHOICE SENDBUF,CHOICE RECVBUF,INTEGER COUNT,
    INTEGER DATATYPE,INTEGER OP,INTEGER COMM,INTEGER REQUEST,
    INTEGER IERROR)

Parameters

sendbuf

is the starting address of the send buffer (choice) (IN)

recvbuf

is the starting address of the receive buffer (choice) (OUT)

count

is the number of elements in sendbuf (integer) (IN)

datatype

is the datatype of elements in sendbuf (handle) (IN)

op

is the reduction operation (handle) (IN)

comm

is the communicator (IN)

request

is the communication request (handle) (OUT)

IERROR

is the FORTRAN return code. It is always the last argument.

Description

This subroutine is a nonblocking version of MPI_SCAN. It performs the same function as MPI_SCAN except that it returns a request handle that must be explicitly completed by using one of the MPI wait or test operations.

Notes

The MPE prefix used with this subroutine indicates that it is an IBM extension to the MPI standard and is not part of the standard itself. MPE routines are provided to enhance the function and the performance of user applications, but applications that use them will not be directly portable to other MPI implementations.

Nonblocking collective communication routines allow for increased efficiency and flexibility in some applications. Because these routines do not synchronize the participating tasks like blocking collective routines generally do, tasks running at different speeds do not waste time waiting for each other.

When it is expected that tasks will be reasonably synchronized, the blocking collective communication routines provided by standard MPI will commonly give better performance than the nonblocking versions.

The nonblocking collective routines can be used in conjunction with the MPI blocking collective routines and can be completed by any of the MPI wait or test functions. Use of MPI_CANCEL and MPI_REQUEST_FREE is not supported.

The threads library has a limit of seven outstanding nonblocking collective calls. A nonblocking call is considered outstanding between the time the call is made and the time the wait is completed. This restriction does not apply to the signal library or to any call defined by the MPI standard.

Applications using nonblocking collective calls often perform best when they run in interrupt mode.

When you use this subroutine in a threads application, make sure all collective operations on a particular communicator are started in the same order at each task. See IBM Parallel Environment for AIX: MPI Programming Guide for more information on programming with MPI in a threads environment.

Errors

Invalid count

count < 0

Invalid datatype

Type not committed

Invalid op

Invalid communicator

Invalid communicator type

must be intracommunicator

Unequal message lengths

MPI_IN_PLACE not valid

MPI not initialized

MPI already finalized

Develop mode error if:

Inconsistent op

Inconsistent datatype

Inconsistent message length

Related information

MPI_SCAN