|
Packit Service |
c5cf8c |
.TH MPI_Igatherv 3 "11/12/2019" " " "MPI"
|
|
Packit Service |
c5cf8c |
.SH NAME
|
|
Packit Service |
c5cf8c |
MPI_Igatherv \- Gathers into specified locations from all processes in a group in a nonblocking way
|
|
Packit Service |
c5cf8c |
.SH SYNOPSIS
|
|
Packit Service |
c5cf8c |
.nf
|
|
Packit Service |
c5cf8c |
int MPI_Igatherv(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf,
|
|
Packit Service |
c5cf8c |
const int recvcounts[], const int displs[], MPI_Datatype recvtype, int root,
|
|
Packit Service |
c5cf8c |
MPI_Comm comm, MPI_Request * request)
|
|
Packit Service |
c5cf8c |
.fi
|
|
Packit Service |
c5cf8c |
.SH INPUT PARAMETERS
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B sendbuf
|
|
Packit Service |
c5cf8c |
- starting address of the send buffer (choice)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B sendcount
|
|
Packit Service |
c5cf8c |
- number of elements in send buffer (non-negative integer)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B sendtype
|
|
Packit Service |
c5cf8c |
- data type of send buffer elements (handle)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B recvcounts
|
|
Packit Service |
c5cf8c |
- non-negative integer array (of length group size) containing the number of elements that are received from each process (significant only at root)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B displs
|
|
Packit Service |
c5cf8c |
- integer array (of length group size). Entry i specifies the displacement relative to recvbuf at which to place the incoming data from process i (significant only at root)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B recvtype
|
|
Packit Service |
c5cf8c |
- data type of receive buffer elements (significant only at root) (handle)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B root
|
|
Packit Service |
c5cf8c |
- rank of receiving process (integer)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B comm
|
|
Packit Service |
c5cf8c |
- communicator (handle)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH OUTPUT PARAMETERS
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B recvbuf
|
|
Packit Service |
c5cf8c |
- starting address of the receive buffer (significant only at root) (choice)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B request
|
|
Packit Service |
c5cf8c |
- communication request (handle)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH THREAD AND INTERRUPT SAFETY
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
This routine is thread-safe. This means that this routine may be
|
|
Packit Service |
c5cf8c |
safely used by multiple threads without the need for any user-provided
|
|
Packit Service |
c5cf8c |
thread locks. However, the routine is not interrupt safe. Typically,
|
|
Packit Service |
c5cf8c |
this is due to the use of memory allocation routines such as
|
|
Packit Service |
c5cf8c |
.I malloc
|
|
Packit Service |
c5cf8c |
or other non-MPICH runtime routines that are themselves not interrupt-safe.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH NOTES FOR FORTRAN
|
|
Packit Service |
c5cf8c |
All MPI routines in Fortran (except for
|
|
Packit Service |
c5cf8c |
.I MPI_WTIME
|
|
Packit Service |
c5cf8c |
and
|
|
Packit Service |
c5cf8c |
.I MPI_WTICK
|
|
Packit Service |
c5cf8c |
) have
|
|
Packit Service |
c5cf8c |
an additional argument
|
|
Packit Service |
c5cf8c |
.I ierr
|
|
Packit Service |
c5cf8c |
at the end of the argument list.
|
|
Packit Service |
c5cf8c |
.I ierr
|
|
Packit Service |
c5cf8c |
is an integer and has the same meaning as the return value of the routine
|
|
Packit Service |
c5cf8c |
in C. In Fortran, MPI routines are subroutines, and are invoked with the
|
|
Packit Service |
c5cf8c |
.I call
|
|
Packit Service |
c5cf8c |
statement.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
All MPI objects (e.g.,
|
|
Packit Service |
c5cf8c |
.I MPI_Datatype
|
|
Packit Service |
c5cf8c |
,
|
|
Packit Service |
c5cf8c |
.I MPI_Comm
|
|
Packit Service |
c5cf8c |
) are of type
|
|
Packit Service |
c5cf8c |
.I INTEGER
|
|
Packit Service |
c5cf8c |
in Fortran.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH ERRORS
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
All MPI routines (except
|
|
Packit Service |
c5cf8c |
.I MPI_Wtime
|
|
Packit Service |
c5cf8c |
and
|
|
Packit Service |
c5cf8c |
.I MPI_Wtick
|
|
Packit Service |
c5cf8c |
) return an error value;
|
|
Packit Service |
c5cf8c |
C routines as the value of the function and Fortran routines in the last
|
|
Packit Service |
c5cf8c |
argument. Before the value is returned, the current MPI error handler is
|
|
Packit Service |
c5cf8c |
called. By default, this error handler aborts the MPI job. The error handler
|
|
Packit Service |
c5cf8c |
may be changed with
|
|
Packit Service |
c5cf8c |
.I MPI_Comm_set_errhandler
|
|
Packit Service |
c5cf8c |
(for communicators),
|
|
Packit Service |
c5cf8c |
.I MPI_File_set_errhandler
|
|
Packit Service |
c5cf8c |
(for files), and
|
|
Packit Service |
c5cf8c |
.I MPI_Win_set_errhandler
|
|
Packit Service |
c5cf8c |
(for
|
|
Packit Service |
c5cf8c |
RMA windows). The MPI-1 routine
|
|
Packit Service |
c5cf8c |
.I MPI_Errhandler_set
|
|
Packit Service |
c5cf8c |
may be used but
|
|
Packit Service |
c5cf8c |
its use is deprecated. The predefined error handler
|
|
Packit Service |
c5cf8c |
.I MPI_ERRORS_RETURN
|
|
Packit Service |
c5cf8c |
may be used to cause error values to be returned.
|
|
Packit Service |
c5cf8c |
Note that MPI does
|
|
Packit Service |
c5cf8c |
.B not
|
|
Packit Service |
c5cf8c |
guarentee that an MPI program can continue past
|
|
Packit Service |
c5cf8c |
an error; however, MPI implementations will attempt to continue whenever
|
|
Packit Service |
c5cf8c |
possible.
|
|
Packit Service |
c5cf8c |
|