MPI_Reduce_scatter(3)

NAME
MPI_Reduce_scatter - Reduce a buffer from each process, and scatter the results to each process in a communicator

SYNOPSIS
#include <mpi.h>
int MPI_Reduce_scatter(void *sendbuf, void *recvbuf, int *counts, MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);

#include <pmpi.h>
int PMPI_Reduce_scatter(void *sendbuf, void *recvbuf, int *counts, MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);

#include <mpi.h>
void MPI::Comm::Reduce_scatter(const void *sendbuf, void *recvbuf, int *counts, const MPI::Datatype &type, const MPI::Op &op) const;

INCLUDE 'mpif.h'
MPI_REDUCE_SCATTER(sendbuf, recvbuf, counts, datatype, op, comm, ierr)
<type> sendbuf(*), recvbuf(*)
INTEGER counts(*), datatype, op, comm, ierr

INPUT PARAMETERS
sendbuf
    - send buffer (array)
counts
    - counts of elements to reduce over for each rank (array of integers)
datatype
    - type of elements in buffers (handle)
op  - reduction operation to perform (handle)
comm
    - communicator for messages (handle)

OUTPUT PARAMETER
recvbuf
    - receive buffer (array)

DESCRIPTION
The MPI_Reduce_scatter() function is used to perform a set of global reductions over a set of buffers in a communicator, comm. The result of the reductions are stored in the recvbuf buffer at each process. This is equivalent to calling MPI_Reduce() for each process, using a different root rank and count of elements to use. The reduction for a given rank is performed over the number of elements specified by that index in the counts array. All reductions have the same type, sendtype and are within an array specified by sendbuf. This function uses the cumulative total counts to determine which data to send to the root ranks for the reduction. The operation to perform, op, must be allowable for the datatype chosen. The operation is assumed to be associative, but may not necessarily be commutative. If op is a user operator, the corresponding user function will be called. It is unspecified on which ranks the function will execute, so all processes should pass the same value to this function. If sendbuf is MPI_IN_PLACE then the source of the message is taken to be recvbuf. This may result in less internal copy operations. Note that each process should send and receive the same amount of data. If that is not the case, then the messages will be silently truncated, or the operation function may be called on uninitialized data. Note that for performance reasons this MPI library does not check that the sent and received datatypes match. The communicator must be a valid one (not MPI_COMM_NULL). PMPI_Reduce_scatter() is the profiling version of this function.

ERRORS
All MPI routines except for MPI_Wtime and MPI_Wtick return an error code. The the current MPI error handler is invoked if the return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable. In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.
MPI_SUCCESS
    - No error;
MPI_ERR_PENDING
    - Pending exception;
MPI_ERR_COMM
    - Invalid communicator;
MPI_ERR_COUNT
    - Invalid element count;
MPI_ERR_BUFFER
    - Invalid buffer;
MPI_ERR_TYPE
    - Invalid data type;
MPI_ERR_OP
    - Invalid operation;
MPI_ERR_INTERN
    - Out of Memory. This may be fatal.

SEE ALSO
MPI_Op_create(3), MPI_Op_free(3), MPI_Reduce(3), MPI_Allreduce(3), MPI_Scan(3), MPI_Exscan(3)