|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
<HTML>
|
|
Packit |
0848f5 |
<HEAD>
|
|
Packit |
0848f5 |
<META NAME="GENERATOR" CONTENT="DOCTEXT">
|
|
Packit |
0848f5 |
<TITLE>MPI_Group_translate_ranks</TITLE>
|
|
Packit |
0848f5 |
</HEAD>
|
|
Packit |
0848f5 |
<BODY BGCOLOR="FFFFFF">
|
|
Packit |
0848f5 |
MPI_Group_translate_ranks
|
|
Packit |
0848f5 |
Translates the ranks of processes in one group to those in another group
|
|
Packit |
0848f5 |
Synopsis
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
int MPI_Group_translate_ranks(MPI_Group group1, int n, const int ranks1[],
|
|
Packit |
0848f5 |
MPI_Group group2, int ranks2[])
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
Input Parameters
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
group1 group1 (handle)
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
n number of ranks in <tt>ranks1</tt> and <tt>ranks2</tt> arrays (integer)
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
ranks1 array of zero or more valid ranks in <tt>group1</tt>
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
group2 group2 (handle)
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
Output Parameters
|
|
Packit |
0848f5 |
- ranks2
- array of corresponding ranks in group2, <tt>MPI_UNDEFINED</tt> when no
|
|
Packit |
0848f5 |
correspondence exists.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
As a special case (see the MPI-2 errata), if the input rank is
|
|
Packit |
0848f5 |
<tt>MPI_PROC_NULL</tt>, <tt>MPI_PROC_NULL</tt> is given as the output rank.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
Thread and Interrupt Safety
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
This routine is thread-safe. This means that this routine may be
|
|
Packit |
0848f5 |
safely used by multiple threads without the need for any user-provided
|
|
Packit |
0848f5 |
thread locks. However, the routine is not interrupt safe. Typically,
|
|
Packit |
0848f5 |
this is due to the use of memory allocation routines such as <tt>malloc
|
|
Packit |
0848f5 |
</tt>or other non-MPICH runtime routines that are themselves not interrupt-safe.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
Notes for Fortran
|
|
Packit |
0848f5 |
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
|
|
Packit |
0848f5 |
an additional argument <tt>ierr</tt> at the end of the argument list. <tt>ierr
|
|
Packit |
0848f5 |
</tt>is an integer and has the same meaning as the return value of the routine
|
|
Packit |
0848f5 |
in C. In Fortran, MPI routines are subroutines, and are invoked with the
|
|
Packit |
0848f5 |
<tt>call</tt> statement.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
|
|
Packit |
0848f5 |
</tt>in Fortran.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
Errors
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
|
|
Packit |
0848f5 |
C routines as the value of the function and Fortran routines in the last
|
|
Packit |
0848f5 |
argument. Before the value is returned, the current MPI error handler is
|
|
Packit |
0848f5 |
called. By default, this error handler aborts the MPI job. The error handler
|
|
Packit |
0848f5 |
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
|
|
Packit |
0848f5 |
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
|
|
Packit |
0848f5 |
RMA windows). The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
|
|
Packit |
0848f5 |
its use is deprecated. The predefined error handler
|
|
Packit |
0848f5 |
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
|
|
Packit |
0848f5 |
Note that MPI does not guarentee that an MPI program can continue past
|
|
Packit |
0848f5 |
an error; however, MPI implementations will attempt to continue whenever
|
|
Packit |
0848f5 |
possible.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
- MPI_SUCCESS
- No error; MPI routine completed successfully.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
</BODY></HTML>
|