Synopsis
int MPI_Iscatterv(const void *sendbuf, const int sendcounts[],
const int displs[], MPI_Datatype sendtype, void *recvbuf,
int recvcount, MPI_Datatype recvtype, int root, MPI_Comm comm,
MPI_Request *request)
int MPI_Iscatterv_c(const void *sendbuf, const MPI_Count sendcounts[],
const MPI_Aint displs[], MPI_Datatype sendtype,
void *recvbuf, MPI_Count recvcount, MPI_Datatype recvtype,
int root, MPI_Comm comm, MPI_Request *request)
Input Parameters
- sendbuf
-
address of send buffer (choice)
- sendcounts
-
non-negative integer array (of length group size) specifying the number of elements to send to each rank (non-negative integer)
- displs
-
integer array (of length group size). Entry i specifies the displacement (relative to sendbuf) from which to take the outgoing data to process i (integer)
- sendtype
-
data type of send buffer elements (handle)
- recvcount
-
number of elements in receive buffer (non-negative integer)
- recvtype
-
data type of receive buffer elements (handle)
- root
-
rank of sending process (integer)
- comm
-
communicator (handle)
Output Parameters
- recvbuf
-
address of receive buffer (choice)
- request
-
communication request (handle)
Description
MPI_Iscatterv starts a nonblocking scatter operation that distributes varying amounts of data from a root process to all processes in a group.
If comm is an intra-communicator, the root sends sendcounts[i] elements from locations specified by displs to each process i. If comm is an inter-communicator, processes in the remote group pass the root’s rank, the root passes MPI_ROOT, and other processes in the root’s group pass MPI_PROC_NULL. The type signature implied by sendcounts[i] and sendtype at the root must equal the type signature implied by recvcount and recvtype at process i. The in-place option for intra-communicators is specified by passing MPI_IN_PLACE as recvbuf at the root, in which case the root sends no data to itself. Once initiated, send buffers and input argument arrays must not be modified and receive buffers must not be accessed until the operation completes. Completion indicates the caller may access buffers but does not indicate that other processes have completed or started the operation. All processes must call collective operations in the same order per communicator, and nonblocking collective operations do not match with blocking collective operations. In multithreaded implementations, users must ensure the same communicator is not used concurrently by two different collective communication initialization calls at the same process. Calling MPI_REQUEST_FREE or MPI_CANCEL on a nonblocking collective request is erroneous.
Thread and Interrupt Safety
This routine is thread-safe. This means that this routine may be safely used by multiple threads without the need for any user-provided thread locks. However, the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as 'malloc' or other non-MPICH runtime routines that are themselves not interrupt-safe.
Notes for Fortran
All MPI routines in Fortran (except for 'MPI_WTIME' and 'MPI_WTICK') have an additional argument 'ierr' at the end of the argument list. 'ierr' is an integer and has the same meaning as the return value of the routine in C. In Fortran, MPI routines are subroutines, and are invoked with the 'call' statement.
All MPI objects (e.g., 'MPI_Datatype', 'MPI_Comm') are of type 'INTEGER' in Fortran.
Errors
All MPI routines (except 'MPI_Wtime' and 'MPI_Wtick') return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with 'MPI_Comm_set_errhandler' (for communicators),
'MPI_File_set_errhandler' (for files), and 'MPI_Win_set_errhandler' (for
RMA windows). The MPI-1 routine 'MPI_Errhandler_set' may be used but
its use is deprecated. 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; however, MPI implementations will attempt to continue whenever
possible.
-
MPI_SUCCESS - No error; MPI routine completed successfully.
-
MPI_ERR_ARG - Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., 'MPI_ERR_RANK').
-
MPI_ERR_BUFFER - Invalid buffer pointer. Usually a null buffer where one is not valid.
-
MPI_ERR_COMM - Invalid communicator. A common error is to use a null communicator in a call (not even allowed in 'MPI_Comm_rank').
-
MPI_ERR_COUNT - Invalid count argument. Count arguments must be non-negative; a count of zero is often valid.
-
MPI_ERR_TYPE - Invalid datatype argument. Additionally, this error can occur if an uncommitted MPI_Datatype (see 'MPI_Type_commit') is used in a communication call.
-
MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.