Blame www/www3/MPI_Alltoallw.html

Packit Service c5cf8c
Packit Service c5cf8c
<HTML>
Packit Service c5cf8c
<HEAD>
Packit Service c5cf8c
<META NAME="GENERATOR" CONTENT="DOCTEXT">
Packit Service c5cf8c
<TITLE>MPI_Alltoallw</TITLE>
Packit Service c5cf8c
</HEAD>
Packit Service c5cf8c
<BODY BGCOLOR="FFFFFF">
Packit Service c5cf8c

MPI_Alltoallw

Packit Service c5cf8c
Generalized all-to-all communication allowing different datatypes, counts, and displacements for each partner 
Packit Service c5cf8c

Synopsis

Packit Service c5cf8c
Packit Service c5cf8c
int MPI_Alltoallw(const void *sendbuf, const int sendcounts[],
Packit Service c5cf8c
                  const int sdispls[], const MPI_Datatype sendtypes[],
Packit Service c5cf8c
                  void *recvbuf, const int recvcounts[], const int rdispls[],
Packit Service c5cf8c
                  const MPI_Datatype recvtypes[], MPI_Comm comm)
Packit Service c5cf8c
Packit Service c5cf8c

Input Parameters

Packit Service c5cf8c
Packit Service c5cf8c
sendbuf
starting address of send buffer (choice)
Packit Service c5cf8c
Packit Service c5cf8c
sendcounts
integer array equal to the group size specifying the number of
Packit Service c5cf8c
elements to send to each processor (integer)
Packit Service c5cf8c
Packit Service c5cf8c
sdispls
integer array (of length group size). Entry j specifies the
Packit Service c5cf8c
displacement in bytes (relative to sendbuf) from which to take the outgoing
Packit Service c5cf8c
data destined for process j
Packit Service c5cf8c
Packit Service c5cf8c
sendtypes
array of datatypes (of length group size). Entry j specifies the
Packit Service c5cf8c
type of data to send to process j (handle)
Packit Service c5cf8c
Packit Service c5cf8c
recvcounts
integer array equal to the group size specifying the number of
Packit Service c5cf8c
elements that can be received from each processor (integer)
Packit Service c5cf8c
Packit Service c5cf8c
rdispls
integer array (of length group size). Entry i specifies the
Packit Service c5cf8c
displacement in bytes (relative to recvbuf) at which to place the incoming
Packit Service c5cf8c
data from process i
Packit Service c5cf8c
Packit Service c5cf8c
recvtypes
array of datatypes (of length group size). Entry i specifies
Packit Service c5cf8c
the type of data received from process i (handle)
Packit Service c5cf8c
Packit Service c5cf8c
comm
communicator (handle)
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

Output Parameters

Packit Service c5cf8c
Packit Service c5cf8c
recvbuf
address of receive buffer (choice)
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

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 <tt>malloc
Packit Service c5cf8c
</tt>or other non-MPICH runtime routines that are themselves not interrupt-safe.
Packit Service c5cf8c

Packit Service c5cf8c

Notes for Fortran

Packit Service c5cf8c
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
Packit Service c5cf8c
an additional argument <tt>ierr</tt> at the end of the argument list.  <tt>ierr
Packit Service c5cf8c
</tt>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
<tt>call</tt> statement.
Packit Service c5cf8c

Packit Service c5cf8c
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
Packit Service c5cf8c
</tt>in Fortran.
Packit Service c5cf8c

Packit Service c5cf8c

Errors

Packit Service c5cf8c

Packit Service c5cf8c
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) 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 <tt>MPI_Comm_set_errhandler</tt> (for communicators),
Packit Service c5cf8c
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
Packit Service c5cf8c
RMA windows).  The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
Packit Service c5cf8c
its use is deprecated.  The predefined error handler
Packit Service c5cf8c
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
Packit Service c5cf8c
Note that MPI does not 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

Packit Service c5cf8c
Packit Service c5cf8c
MPI_SUCCESS
No error; MPI routine completed successfully.
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_COMM
Invalid communicator. A common error is to use a null
Packit Service c5cf8c
communicator in a call (not even allowed in <tt>MPI_Comm_rank</tt>).
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_ARG
Invalid argument. Some argument is invalid and is not
Packit Service c5cf8c
identified by a specific error class (e.g., <tt>MPI_ERR_RANK</tt>).
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_COUNT
Invalid count argument. Count arguments must be
Packit Service c5cf8c
non-negative; a count of zero is often valid.
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_TYPE
Invalid datatype argument. Additionally, this error can
Packit Service c5cf8c
occur if an uncommitted MPI_Datatype (see <tt>MPI_Type_commit</tt>) is used
Packit Service c5cf8c
in a communication call.
Packit Service c5cf8c
Packit Service c5cf8c
</BODY></HTML>