1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
|
.TH MPI_Group_translate_ranks 3 "2/18/1997" " " "MPI"
.SH NAME
MPI_Group_translate_ranks \- Translates the ranks of processes in one group to those in another group
.SH SYNOPSIS
.nf
#include "mpi.h"
int MPI_Group_translate_ranks ( group_a, n, ranks_a, group_b, ranks_b )
MPI_Group group_a;
int n;
int *ranks_a;
MPI_Group group_b;
int *ranks_b;
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B group1
- group1 (handle)
.PD 1
.PD 0
.TP
.B n
- number of ranks in
.I ranks1
and
.I ranks2
arrays (integer)
.PD 1
.PD 0
.TP
.B ranks1
- array of zero or more valid ranks in
.I group1
.PD 1
.PD 0
.TP
.B group2
- group2 (handle)
.PD 1
.SH OUTPUT PARAMETER
.PD 0
.TP
.B ranks2
- array of corresponding ranks in group2,
.I MPI_UNDEFINED
when no
correspondence exists.
.PD 1
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I 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
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I 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
.I MPI_Errhandler_set
; the predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
an error.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_GROUP
- Null group passed to function.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_RANK
- Invalid source or destination rank. Ranks must be between
zero and the size of the communicator minus one; ranks in a receive
(
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may also be
.I MPI_ANY_SOURCE
.
.PD 1
.SH LOCATION
group_tranks.c
|