1MPI_Group_incl(3) LAM/MPI MPI_Group_incl(3)
2
6 MPI_Group_incl - Produces a group by reordering an existing group and
7 taking only listed members
8
10 #include <mpi.h>
11 int MPI_Group_incl(MPI_Group g, int n, int *ranks,
12 MPI_Group *png)
13
15 g - group (handle)
16 n - number of elements in array ranks (and size of newgroup )
17 (integer)
18 ranks - ranks of processes in g to appear in png (array of integers)
19
22 png - new group derived from above, in the order defined by ranks
23 (handle)
24
27 When a group is no longer being used, it should be freed with
28 MPI_Group_free .
29
33 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
34 an additional argument ierr at the end of the argument list. ierr is
35 an integer and has the same meaning as the return value of the routine
36 in C. In Fortran, MPI routines are subroutines, and are invoked with
37 the call statement.
38 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
40 Fortran.
41
44 If an error occurs in an MPI function, the current MPI error handler is
45 called to handle it. By default, this error handler aborts the MPI
46 job. The error handler may be changed with MPI_Errhandler_set ; the
47 predefined error handler MPI_ERRORS_RETURN may be used to cause error
48 values to be returned (in C and Fortran; this error handler is less
49 useful in with the C++ MPI bindings. The predefined error handler
50 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
51 needs to be recovered). Note that MPI does not guarantee that an MPI
52 program can continue past an error.
53 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
55 value; C routines as the value of the function and Fortran routines in
56 the last argument. The C++ bindings for MPI do not return error val‐
57 ues; instead, error values are communicated by throwing exceptions of
58 type MPI::Exception (but not by default). Exceptions are only thrown
59 if the error value is not MPI::SUCCESS .
60 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
63 functions will return upon an error, there will be no way to recover
64 what the actual error value was.
65 MPI_SUCCESS
66 - No error; MPI routine completed successfully.
67 MPI_ERR_GROUP
68 - Null group passed to function.
69 MPI_ERR_OTHER
70 - This error is returned when some part of the LAM/MPI implemen‐
71 tation is unable to acquire memory.
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 gincl.c
106LAM/MPI 7.1.2 2/23/2006 MPI_Group_incl(3)