1MPI_Group_excl(3) LAM/MPI MPI_Group_excl(3)
2
6 MPI_Group_excl - Produces a group by reordering an existing group and
7 taking only unlisted members
8
10 #include <mpi.h>
11 int MPI_Group_excl(MPI_Group g, int n, int *ranks,
12 MPI_Group *png)
13
15 g - group (handle)
16 n - number of elements in array ranks (integer)
17 ranks - array of integer ranks in g not to appear in png
18
22 png - new group derived from above, preserving the order defined by
23 group (handle)
24
27 Each of the ranks to exclude must be a valid rank in the group and all
28 elements must be distinct or the function is erroneous.
29 When a group is no longer being used, it should be freed with
31 MPI_Group_free .
32
36 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
37 an additional argument ierr at the end of the argument list. ierr is
38 an integer and has the same meaning as the return value of the routine
39 in C. In Fortran, MPI routines are subroutines, and are invoked with
40 the call statement.
41 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
43 Fortran.
44
47 If an error occurs in an MPI function, the current MPI error handler is
48 called to handle it. By default, this error handler aborts the MPI
49 job. The error handler may be changed with MPI_Errhandler_set ; the
50 predefined error handler MPI_ERRORS_RETURN may be used to cause error
51 values to be returned (in C and Fortran; this error handler is less
52 useful in with the C++ MPI bindings. The predefined error handler
53 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
54 needs to be recovered). Note that MPI does not guarantee that an MPI
55 program can continue past an error.
56 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
58 value; C routines as the value of the function and Fortran routines in
59 the last argument. The C++ bindings for MPI do not return error val‐
60 ues; instead, error values are communicated by throwing exceptions of
61 type MPI::Exception (but not by default). Exceptions are only thrown
62 if the error value is not MPI::SUCCESS .
63 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
66 functions will return upon an error, there will be no way to recover
67 what the actual error value was.
68 MPI_SUCCESS
69 - No error; MPI routine completed successfully.
70 MPI_ERR_GROUP
71 - Null group passed to function.
72 MPI_ERR_ARG
73 - Invalid argument. Some argument is invalid and is not identi‐
74 fied by a specific error class. This is typically a NULL
75 pointer or other such error.
76 MPI_ERR_RANK
77 - Invalid source or destination rank. Ranks must be between
78 zero and the size of the communicator minus one; ranks in a
79 receive ( MPI_Recv , MPI_Irecv , MPI_Sendrecv , etc.) may also
80 be MPI_ANY_SOURCE .
81
85 MPI_Group_free
86
89 For more information, please see the official MPI Forum web site, which
90 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
91 ments contain detailed information about each MPI function (most of
92 which is not duplicated in these man pages).
93 http://www.mpi-forum.org/
95
99 The LAM Team would like the thank the MPICH Team for the handy program
100 to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
101 ing/sowing.tar.gz ), the initial formatting, and some initial text for
102 most of the MPI-1 man pages.
103
105 gexcl.c
106LAM/MPI 7.1.2 2/23/2006 MPI_Group_excl(3)