1MPI_Group_translate_ranks(3) LAM/MPI MPI_Group_translate_ranks(3)
2
6 MPI_Group_translate_ranks - Translates the ranks of processes in one
7 group to those in another group
8
10 #include <mpi.h>
11 int MPI_Group_translate_ranks(MPI_Group g1, int n,
12 int *r1, MPI_Group g2, int *r2)
13
15 g1 - group1 (handle)
16 n - number of ranks in r1 and r2 arrays (integer)
17 r1 - array of zero or more valid ranks in g1
18 g2 - group2 (handle)
20
23 r2 - array of corresponding ranks in g2 , MPI_UNDEFINED when no
24 correspondence exists.
25
28 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
29 an additional argument ierr at the end of the argument list. ierr is
30 an integer and has the same meaning as the return value of the routine
31 in C. In Fortran, MPI routines are subroutines, and are invoked with
32 the call statement.
33 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
35 Fortran.
36
39 If an error occurs in an MPI function, the current MPI error handler is
40 called to handle it. By default, this error handler aborts the MPI
41 job. The error handler may be changed with MPI_Errhandler_set ; the
42 predefined error handler MPI_ERRORS_RETURN may be used to cause error
43 values to be returned (in C and Fortran; this error handler is less
44 useful in with the C++ MPI bindings. The predefined error handler
45 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
46 needs to be recovered). Note that MPI does not guarantee that an MPI
47 program can continue past an error.
48 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
50 value; C routines as the value of the function and Fortran routines in
51 the last argument. The C++ bindings for MPI do not return error val‐
52 ues; instead, error values are communicated by throwing exceptions of
53 type MPI::Exception (but not by default). Exceptions are only thrown
54 if the error value is not MPI::SUCCESS .
55 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
58 functions will return upon an error, there will be no way to recover
59 what the actual error value was.
60 MPI_SUCCESS
61 - No error; MPI routine completed successfully.
62 MPI_ERR_GROUP
63 - Null group passed to function.
64 MPI_ERR_ARG
65 - Invalid argument. Some argument is invalid and is not identi‐
66 fied by a specific error class. This is typically a NULL
67 pointer or other such error.
68 MPI_ERR_RANK
69 - Invalid source or destination rank. Ranks must be between
70 zero and the size of the communicator minus one; ranks in a
71 receive ( MPI_Recv , MPI_Irecv , MPI_Sendrecv , etc.) may also
72 be MPI_ANY_SOURCE .
73
77 For more information, please see the official MPI Forum web site, which
78 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
79 ments contain detailed information about each MPI function (most of
80 which is not duplicated in these man pages).
81 http://www.mpi-forum.org/
83
87 The LAM Team would like the thank the MPICH Team for the handy program
88 to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
89 ing/sowing.tar.gz ), the initial formatting, and some initial text for
90 most of the MPI-1 man pages.
91
93 gtranks.c
94LAM/MPI 7.1.2 2/23/2006 MPI_Group_translate_ranks(3)