1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Group_incl 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Group_incl \fP \- Produces a group by reordering an existing group and taking only listed members. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Group_incl(MPI_Group \fIgroup\fP, int\fI n\fP, int\fI *ranks\fP, |
---|
13 | MPI_Group\fI *newgroup\fP) |
---|
14 | |
---|
15 | .SH Fortran Syntax |
---|
16 | .nf |
---|
17 | INCLUDE 'mpif.h' |
---|
18 | MPI_GROUP_INCL(\fIGROUP, N, RANKS, NEWGROUP, IERROR\fP) |
---|
19 | INTEGER \fIGROUP, N, RANKS(*), NEWGROUP, IERROR\fP |
---|
20 | |
---|
21 | .SH C++ Syntax |
---|
22 | .nf |
---|
23 | #include <mpi.h> |
---|
24 | Group Group::Incl(int \fIn\fP, const int \fIranks\fP[]) const |
---|
25 | |
---|
26 | .SH INPUT PARAMETERS |
---|
27 | .ft R |
---|
28 | .TP 1i |
---|
29 | group |
---|
30 | Group (handle). |
---|
31 | .TP 1i |
---|
32 | n |
---|
33 | Number of elements in array ranks (and size of \fInewgroup\fP)(integer). |
---|
34 | .TP 1i |
---|
35 | ranks |
---|
36 | Ranks of processes in group to appear in newgroup (array of integers). |
---|
37 | |
---|
38 | .SH OUTPUT PARAMETERS |
---|
39 | .ft R |
---|
40 | .TP 1i |
---|
41 | newgroup |
---|
42 | New group derived from above, in the order defined by ranks (handle). |
---|
43 | .ft R |
---|
44 | .TP 1i |
---|
45 | IERROR |
---|
46 | Fortran only: Error status (integer). |
---|
47 | |
---|
48 | .SH DESCRIPTION |
---|
49 | .ft R |
---|
50 | The function MPI_Group_incl creates a group group_out that consists of the n processes in group with ranks rank[0], \&..., rank[n-1]; the process with rank i in group_out is the process with rank ranks[i] in group. Each of the n elements of ranks must be a valid rank in group and all elements must be distinct, or else the program is erroneous. If n = 0, then group_out is MPI_GROUP_EMPTY. This function can, for instance, be used to reorder the elements of a group. |
---|
51 | |
---|
52 | .SH NOTE |
---|
53 | .ft R |
---|
54 | This implementation does not currently check to ensure that there are no |
---|
55 | duplicates in the list of ranks. |
---|
56 | |
---|
57 | .SH ERRORS |
---|
58 | Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI:Exception object. |
---|
59 | .sp |
---|
60 | Before the error value is returned, the current MPI error handler is |
---|
61 | called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error. |
---|
62 | |
---|
63 | .SH SEE ALSO |
---|
64 | .ft R |
---|
65 | .sp |
---|
66 | MPI_Group_compare |
---|
67 | .br |
---|
68 | MPI_Group_range_incl |
---|
69 | .br |
---|
70 | MPI_Group_free |
---|
71 | |
---|