Edit

Share via

MPI_Scan function

  • Article

Computes the scan (partial reductions) of data on a collection of processes.

Syntax

int MPIAPI MPI_Scan(
  _In_  void         *sendbuf,
  _Out_ void         *recvbuf,
        int          count,
        MPI_Datatype datatype,
        MPI_Op       op,
        MPI_Comm     comm
);

Parameters

  • sendbuf [in]
    Starting address of send buffer.

  • recvbuf [out]
    Starting address of receive buffer.

  • count
    Number of elements in input buffer.

  • datatype
    Datatype of elements of input buffer.

  • op
    Operation.

  • comm
    Communicator.

Return value

Returns MPI_SUCCESS on success. Otherwise, the return value is an error code.

In Fortran, the return value is stored in the IERROR parameter.

Fortran

    MPI_SCAN(SENDBUF, RECVBUF, COUNT, DATATYPE, OP, COMM, IERROR)
        <type> SENDBUF(*), RECVBUF(*)
        INTEGER COUNT, DATATYPE, OP, COMM, IERROR

Requirements

Product

HPC Pack 2012 MS-MPI Redistributable Package, HPC Pack 2008 R2 MS-MPI Redistributable Package, HPC Pack 2008 MS-MPI Redistributable Package or HPC Pack 2008 Client Utilities

Header

 Mpi.h; Mpif.h

Library

 Msmpi.lib

DLL

 Msmpi.dll

See also

MPI Collective Functions